Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial sample generation documentation #184

Merged
merged 5 commits into from
Aug 21, 2019

Conversation

software-dov
Copy link
Contributor

No description provided.

@googlebot googlebot added the cla: yes This human has signed the Contributor License Agreement. label Aug 20, 2019
@codecov
Copy link

codecov bot commented Aug 20, 2019

Codecov Report

Merging #184 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@          Coverage Diff          @@
##           master   #184   +/-   ##
=====================================
  Coverage     100%   100%           
=====================================
  Files          25     25           
  Lines        1197   1197           
  Branches      259    259           
=====================================
  Hits         1197   1197

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 88ab687...5f873c9. Read the comment docs.

Add an image to docker invocation example
Consume '--samples' option in entry
@software-dov software-dov requested a review from yihanzhen August 20, 2019 23:30
@software-dov software-dov requested a review from yihanzhen August 21, 2019 16:33
Copy link
Contributor

@vchudnov-g vchudnov-g left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments, particularly about finding a SPOT for the repeated content.

~~~~~~~~~~~~~~~~~~

In addition to generating client libraries, the generator can also create standalone
executable code samples.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: line wrap

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not quite sure what you mean. Other rst files use 80 columns max, and the resulting html is single-newline agnostic.

docs/getting-started/docker.rst Outdated Show resolved Hide resolved
docs/getting-started/docker.rst Outdated Show resolved Hide resolved
~~~~~~~~~~~~~~~~~~

In addition to generating client libraries, the generator can also create standalone
executable code samples.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: line wrap

docs/getting-started/local.rst Outdated Show resolved Hide resolved
docs/getting-started/local.rst Outdated Show resolved Hide resolved
docs/getting-started/local.rst Outdated Show resolved Hide resolved
@software-dov
Copy link
Contributor Author

software-dov commented Aug 21, 2019

Lighthearted aside: 'finding a SPOT' works both as an expanded and unexpanded acronym.

A.C.R.O.N.Y.M.: A Criminal Regiment Of Nasty Young Men

@software-dov software-dov merged commit f71fc44 into googleapis:master Aug 21, 2019
@software-dov software-dov deleted the docs branch August 22, 2019 17:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cla: yes This human has signed the Contributor License Agreement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants