Skip to content
New issue

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

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

Already on GitHub? # to your account

Fix name_pretty and templates so generated documentation reads smoothly #13101

Open
3 tasks
vchudnov-g opened this issue Sep 23, 2024 · 0 comments
Open
3 tasks
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: process A process-related concern. May include testing, release, or the like.

Comments

@vchudnov-g
Copy link
Contributor

In the synthtool Python templates ,the docs/summary_overview.md template uses {{ name_pretty }} API in the text, while the README template only says Python client for {{ name_pretty }}

In Google Cloud Python, the .repo-metadata.json files has an inconsistent convention for name_pretty: for some APIs , it ends with the acronym API, leading to stutter in summary_overview.md ("Foo API API"; first noticed in #13100), and for some APIs it does not.

We need to:

  1. establish a clear convention for the name_pretty format and for synthtool templates;
  2. enforce the convention in google-cloud-python (e.g. have automation that adds/removes the appropriate string suffix, so that, for example, name_pretty doesn't end in "API"); and
  3. enforce the convention in synthtool, making sure the templates generate files that read smoothly.
@vchudnov-g vchudnov-g added priority: p2 Moderately-important priority. Fix may not be included in next release. type: process A process-related concern. May include testing, release, or the like. labels Sep 23, 2024
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
priority: p2 Moderately-important priority. Fix may not be included in next release. type: process A process-related concern. May include testing, release, or the like.
Projects
None yet
Development

No branches or pull requests

1 participant