chore: remove name_pretty_override from librarian.yaml#16797
chore: remove name_pretty_override from librarian.yaml#16797jskeet wants to merge 5 commits intogoogleapis:mainfrom
Conversation
jskeet
requested review from
GarrettWu and
daniel-sanche
and removed request for
a team
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request standardizes product display names across numerous libraries by removing "Google Cloud" and "API" suffixes from metadata and documentation. While most updates are correct, the removal of name_pretty from both librarian.yaml and .repo-metadata.json for the google-apps-card, google-cloud-appengine-logging, and google-cloud-bigquery-logging packages has caused critical documentation errors. These include empty product names in titles, incorrect underline formatting in RST files, and broken link references in the generated README.rst and summary_overview.md files. The reviewer recommends restoring valid name_pretty values in the metadata files to ensure the documentation remains functional and correctly formatted.
| "language": "python", | ||
| "library_type": "GAPIC_AUTO", | ||
| "name": "google-apps-card", | ||
| "name_pretty": "Google Apps Card Protos", |
There was a problem hiding this comment.
Removing name_pretty from .repo-metadata.json while also removing the override in librarian.yaml causes the generated documentation (README.rst, summary_overview.md) to have empty product names and broken links. Please provide a valid name_pretty value instead of removing it.
| "name_pretty": "Google Apps Card Protos", | |
| "name_pretty": "Apps Card", |
| "language": "python", | ||
| "library_type": "OTHER", | ||
| "name": "appenginelogging", | ||
| "name_pretty": "App Engine Logging Protos", |
There was a problem hiding this comment.
Removing name_pretty from .repo-metadata.json while also removing the override in librarian.yaml causes the generated documentation to have empty product names. Please provide a valid name_pretty value instead of removing it.
| "name_pretty": "App Engine Logging Protos", | |
| "name_pretty": "App Engine Logging", |
| "language": "python", | ||
| "library_type": "OTHER", | ||
| "name": "bigquerylogging", | ||
| "name_pretty": "BigQuery Logging Protos", |
There was a problem hiding this comment.
Removing name_pretty from .repo-metadata.json while also removing the override in librarian.yaml causes the generated documentation to have empty product names. Please provide a valid name_pretty value instead of removing it.
| "name_pretty": "BigQuery Logging Protos", | |
| "name_pretty": "BigQuery Logging", |
| Python Client for | ||
| ================== |
There was a problem hiding this comment.
The product name is missing in the title, and the underline length is incorrect. This is a result of removing name_pretty from the metadata files.
| |preview| |pypi| |versions| | ||
|
|
||
| `Google Apps Card Protos`_: Google Apps Card Protos | ||
| ``_: Google Apps Card Protos |
There was a problem hiding this comment.
The link reference is broken (empty backticks) due to the missing product name.
| ]: # | ||
|
|
||
| # BigQuery Logging Protos API | ||
| # API |
There was a problem hiding this comment.
The title is broken (empty name) due to the removal of name_pretty from the metadata.
|
As before, anything that's missing for a generated library (as opposed to handwritten) can be added to sdk.yaml. I believe that list is:
|
|
Titles added in googleapis/librarian#5587 |
|
I'm going to remove the google-cloud-storage changes from this PR as we know it's failing at the moment. |
jskeet
force-pushed
the
remove-name-pretty-override
branch
from
726783d to
fea2620
Compare
1 participant
Towards googleapis/librarian#5463