chore: remove name_pretty_override from google-cloud-maintenance-api #16842
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| # Copyright 2026 Google LLC | ||
| # | ||
| # Licensed under the Apache License, Version 2.0 (the "License"); | ||
| # you may not use this file except in compliance with the License. | ||
| # You may obtain a copy of the License at | ||
| # | ||
| # http://www.apache.org/licenses/LICENSE-2.0 | ||
| # | ||
| # Unless required by applicable law or agreed to in writing, software | ||
| # distributed under the License is distributed on an "AS IS" BASIS, | ||
| # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| # See the License for the specific language governing permissions and | ||
| # limitations under the License. | ||
| description: Fix duplicate links in google-cloud-maintenance-api | ||
| url: https://github.com/googleapis/librarian/issues/5668 | ||
| replacements: | ||
| - paths: [ | ||
| packages/google-cloud-maintenance-api/README.rst | ||
| ] | ||
| before: '`Maintenance`' | ||
| after: '`Cloud Maintenance`' | ||
| count: 1 | ||
| - paths: [ | ||
| packages/google-cloud-maintenance-api/README.rst | ||
| ] | ||
| before: '_Maintenance:' | ||
| after: '_Cloud Maintenance:' | ||
| count: 1 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -1,9 +1,9 @@ | ||||||
| Python Client for Maintenance | ||||||
| ============================= | ||||||
|
|
||||||
| |preview| |pypi| |versions| | ||||||
|
|
||||||
| `Cloud Maintenance`_: The Maintenance API provides a centralized view of planned disruptive maintenance events across supported Google Cloud products. It offers users visibility into upcoming, ongoing, and completed maintenance, along with controls to manage certain maintenance activities, such as mainteance windows, rescheduling, and on-demand updates. | ||||||
|
|
||||||
| - `Client Library Documentation`_ | ||||||
| - `Product Documentation`_ | ||||||
|
|
@@ -14,7 +14,7 @@ Python Client for Maintenance API | |||||
| :target: https://pypi.org/project/google-cloud-maintenance-api/ | ||||||
| .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-maintenance-api.svg | ||||||
| :target: https://pypi.org/project/google-cloud-maintenance-api/ | ||||||
| .. _Cloud Maintenance: https://cloud.google.com/unified-maintenance/ | ||||||
| .. _Client Library Documentation: https://cloud.google.com/python/docs/reference/google-cloud-maintenance-api/latest/summary_overview | ||||||
| .. _Product Documentation: https://cloud.google.com/unified-maintenance/ | ||||||
|
|
||||||
|
|
@@ -25,12 +25,12 @@ In order to use this library, you first need to go through the following steps: | |||||
|
|
||||||
| 1. `Select or create a Cloud Platform project.`_ | ||||||
| 2. `Enable billing for your project.`_ | ||||||
| 3. `Enable the Maintenance.`_ | ||||||
|
Contributor
There was a problem hiding this comment. The phrase "Enable the Maintenance" is grammatically awkward. It should be "Enable Maintenance" or "Enable the Maintenance API". Since the goal of this change appears to be removing "API" from the product name, "Enable Maintenance" is a better fit.
Suggested change
|
||||||
| 4. `Set up Authentication.`_ | ||||||
|
|
||||||
| .. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project | ||||||
| .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project | ||||||
| .. _Enable the Maintenance.: https://cloud.google.com/unified-maintenance/ | ||||||
|
Contributor
There was a problem hiding this comment. This link reference should be updated to match the suggested change in the list item for consistency.
Suggested change
|
||||||
| .. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html | ||||||
|
|
||||||
| Installation | ||||||
|
|
@@ -97,14 +97,14 @@ Windows | |||||
| Next Steps | ||||||
| ~~~~~~~~~~ | ||||||
|
|
||||||
| - Read the `Client Library Documentation`_ for Maintenance | ||||||
| to see other available methods on the client. | ||||||
| - Read the `Maintenance Product documentation`_ to learn | ||||||
| more about the product and see How-to Guides. | ||||||
| - View this `README`_ to see the full list of Cloud | ||||||
| APIs that we cover. | ||||||
|
|
||||||
| .. _Maintenance Product documentation: https://cloud.google.com/unified-maintenance/ | ||||||
| .. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst | ||||||
|
|
||||||
| Logging | ||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,7 +2,7 @@ | |||||
|
|
||||||
| .. include:: multiprocessing.rst | ||||||
|
|
||||||
| This package includes clients for multiple versions of Maintenance. | ||||||
|
Contributor
There was a problem hiding this comment. The phrase "versions of Maintenance" is ambiguous and sounds like it refers to maintenance events rather than the service. Using "versions of the Maintenance API" or "versions of the Maintenance service" would be much clearer.
Suggested change
|
||||||
| By default, you will get version ``maintenance_api_v1``. | ||||||
|
|
||||||
|
|
||||||
|
|
||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -5,14 +5,14 @@ reverted. Instead, if you want to place additional content, create an | |
| pick up on the content and merge the content. | ||
| ]: # | ||
|
|
||
| # Maintenance API | ||
|
|
||
| Overview of the APIs available for Maintenance API. | ||
|
|
||
| ## All entries | ||
|
|
||
| Classes, methods and properties & attributes for | ||
| Maintenance API. | ||
|
|
||
| [classes](https://cloud.google.com/python/docs/reference/google-cloud-maintenance-api/latest/summary_class.html) | ||
|
|
||
|
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it be better to keep the override rather than add post processing here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think so, because it's really not that we want to override the "pretty name" in general - we just want to fix the link. Aside from anything else, this is a whole option that will be blocked from removal (I believe) based on just this API.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ack. Adding post processing is a slippery slope. We should file a bug to follow up on this. In the meantime I'll approve it so that we don't want to block the overall migration effort.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We've got googleapis/librarian#5668 :)