docs: add guidance for using GetParameterVersion#14118
docs: add guidance for using GetParameterVersion#14118YashSaraf11 merged 1 commit intoGoogleCloudPlatform:mainfrom
Conversation
There was a problem hiding this comment.
Code Review
This pull request adds a documentation comment to the get_param_version function to clarify that it is intended for retrieving metadata rather than high-volume access. The review feedback suggests improving the comment's formatting by removing unnecessary blank lines and using the canonical cloud.google.com domain for the provided link.
|
|
||
| # The GetParameterVersion operation retrieves parameter metadata and doesn't | ||
| # support high-volume access. To access parameter values at scale, | ||
| # see Access a parameter version (https://docs.cloud.google.com/secret-manager/parameter-manager/docs/render-parameter-version). | ||
|
|
||
|
|
There was a problem hiding this comment.
The added guidance comment is separated from the function by multiple blank lines, which reduces its clarity and association with the get_param_version function. Additionally, the URL should use the canonical cloud.google.com domain instead of docs.cloud.google.com.
| # The GetParameterVersion operation retrieves parameter metadata and doesn't | |
| # support high-volume access. To access parameter values at scale, | |
| # see Access a parameter version (https://docs.cloud.google.com/secret-manager/parameter-manager/docs/render-parameter-version). | |
| # The GetParameterVersion operation retrieves parameter metadata and doesn't | |
| # support high-volume access. To access parameter values at scale, | |
| # see Access a parameter version (https://cloud.google.com/secret-manager/parameter-manager/docs/render-parameter-version). |
YashSaraf11
left a comment
There was a problem hiding this comment.
nit: extra line added can be removed
Description
Fixes #
Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.
Checklist
nox -s py-3.9(see Test Environment Setup)nox -s lint(see Test Environment Setup)