python-docs-samples icon indicating copy to clipboard operation
python-docs-samples copied to clipboard

Regional samples

Open vipul7499 opened this issue 1 year ago • 2 comments

Description

Fixes #<ISSUE-NUMBER>

Note: Before submitting a pull request, please open an issue for discussion if you are not associated with Google.

Checklist

vipul7499 avatar Jun 27 '24 04:06 vipul7499

Here is the summary of changes.

You are about to add 24 region tags.

This comment is generated by snippet-bot. If you find problems with this result, please file an issue at: https://github.com/googleapis/repo-automation-bots/issues. To update this comment, add snippet-bot:force-run label or use the checkbox below:

  • [ ] Refresh this comment

snippet-bot[bot] avatar Jun 27 '24 04:06 snippet-bot[bot]

thanks @vipul7499; flagging this as I think we need to figure out how we handle this kind of need versus duplicating a bunch of code and adding the single feature of being able to add location. I don't think we want to double the size of samples maintained and have 2 separate places we maintain the code.

Hey @iennae , we would need to go through the current approach because we are going to write a whole new documentation for the regionalized secrets, so we will need a different set of samples for the same. It is done because regionalized samples is more than just a feature addition as it will be the DRZ compliant version of the secret manager.

cc : @kapishps

vipul7499 avatar Jul 05 '24 05:07 vipul7499

@iennae

Thanks for reviewing this PR. The samples are for DRZ compliant new APIs in Secret Manager. Though the samples look like it's a duplicate of the existing ones, there's a tweak in the API resource expectations. Would be happy to clarify further.

Sita04 avatar Jul 15 '24 15:07 Sita04

Hey @iennae is there any update on the review process? Can you please provide an estimate timeline?

vipul7499 avatar Jul 19 '24 05:07 vipul7499

Hey @iennae any update on this?

vipul7499 avatar Aug 06 '24 04:08 vipul7499

Hi @vipul7499 sharing a few suggestion!

  1. This PR has a lot to review for 1 person. 2K lines of code with 26 files. Kindly reduce the no.of file updates in this PR.

  2. To improve code readability, can you please add some form of example doc tests ?

Example

def factorial(n):
    """Return the factorial of n, an exact integer >= 0.

    >>> factorial(5)
    120
    """
    import math
    if not n >= 0:
        raise ValueError("n must be >= 0")
    ...
    ...
    return result
  1. Please use a new test.py file. preferable a new folder.

msampathkumar avatar Aug 19 '24 15:08 msampathkumar

Hey @msampathkumar @Sita04 I have broken down this PR into these PRs: https://github.com/GoogleCloudPlatform/python-docs-samples/pull/12475 https://github.com/GoogleCloudPlatform/python-docs-samples/pull/12477 https://github.com/GoogleCloudPlatform/python-docs-samples/pull/12479 https://github.com/GoogleCloudPlatform/python-docs-samples/pull/12480 https://github.com/GoogleCloudPlatform/python-docs-samples/pull/12481

vipul7499 avatar Aug 22 '24 13:08 vipul7499

Thanks @vipul7499 Let's go ahead and close this PR.

Sita04 avatar Aug 22 '24 14:08 Sita04