google-cloud-python
google-cloud-python copied to clipboard
Fix `name_pretty` and templates so generated documentation reads smoothly
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:
- [ ] establish a clear convention for the
name_prettyformat and for synthtool templates; - [ ] enforce the convention in google-cloud-python (e.g. have automation that adds/removes the appropriate string suffix, so that, for example,
name_prettydoesn't end in "API"); and - [ ] enforce the convention in synthtool, making sure the templates generate files that read smoothly.