Skip to content

Fix samples readme reference #431

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

Closed
jsoref opened this issue Mar 9, 2020 · 2 comments
Closed

Fix samples readme reference #431

jsoref opened this issue Mar 9, 2020 · 2 comments
Assignees
Labels
type: docs Improvement to the documentation for an API.

Comments

@jsoref
Copy link
Contributor

jsoref commented Mar 9, 2020

Thanks for stopping by to let us know something could be better!

Environment details

  • synthtool version: master

Steps to reproduce

  1. Read the sentence in https://github.com/googleapis/nodejs-dlp/blob/master/README.md#samples
  2. Determine that the grammar is confusing and that the message is wrong.
  3. File Fix samples readme reference nodejs-dlp#423
  4. Told to file an issue
@jsoref
Copy link
Contributor Author

jsoref commented Mar 9, 2020

@bcoe:
Afaiu, you're thinking about https://github.com/googleapis/synthtool/blob/master/synthtool/gcp/templates/node_library/samples/README.md which is a separate file.

If you mean that the message itself is talking about those files, then the change should be of the form:

## Samples

-Samples are in the [`samples/`](https://github.com/{{  metadata['repo']['repo'] }}/tree/master/samples) directory. The samples' `README.md`
-has instructions for running the samples.
+Samples are in the [`samples/`](https://github.com/{{  metadata['repo']['repo'] }}/tree/master/samples) directory. Each sample's `README.md`
+has instructions for running its sample.

I'm happy to make a PR for that if that's the intention. Or if the intention is closer to my initial interpretation, I'm happy to make a PR for that.

@yoshi-automation yoshi-automation added the triage me I really want to be triaged. label Mar 10, 2020
@bcoe bcoe added the type: docs Improvement to the documentation for an API. label Mar 10, 2020
@yoshi-automation yoshi-automation removed the triage me I really want to be triaged. label Mar 10, 2020
@sofisl
Copy link
Contributor

sofisl commented Dec 9, 2020

Addressed in #872, will hold off on merging until after fix-it week

@sofisl sofisl closed this as completed Dec 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Improvement to the documentation for an API.
Projects
None yet
Development

No branches or pull requests

4 participants