Skip to content
This repository was archived by the owner on Dec 31, 2023. It is now read-only.

docs(samples): add doc strings to explain the project ID format #469

Merged
merged 3 commits into from
Aug 6, 2022
Merged

docs(samples): add doc strings to explain the project ID format #469

merged 3 commits into from
Aug 6, 2022

Conversation

Shabirmean
Copy link
Member

Fixes: b/239908395

Description

  • The issue reports that it is unclear from the portion of the code that is seen in the docs (the ones within the region tags), in what format the project_name is expected.
  • Thus, need to add some information about it within the region tags that is surfaced in the docs

Changes:

  • Added doc strings for all the methods that use project_name to explain what the project name format must be
  • Also added other parameter explanations where there were other arguments other than project_name.

@product-auto-label product-auto-label bot added size: s Pull request size is small. api: monitoring Issues related to the googleapis/python-monitoring API. labels Aug 2, 2022
@Shabirmean Shabirmean requested review from arithmetic1728, a team and nicain and removed request for a team August 2, 2022 18:52
@arbrown arbrown requested a review from parthea August 2, 2022 20:00
@Shabirmean Shabirmean added the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 2, 2022
@yoshi-kokoro yoshi-kokoro removed the kokoro:force-run Add this label to force Kokoro to re-run the tests. label Aug 2, 2022
@Shabirmean
Copy link
Member Author

@parthea - Do you know why the Kokoro Prerelease Dependencies is failing? The only changes were comments in this PR

@parthea
Copy link
Contributor

parthea commented Aug 6, 2022

The Kokoro Prerelease Dependencies tests the latest version of dependencies. The test should pass in the next release of protobuf. The issue was fixed in b/240473922 but the release is not yet published to pypi. The Kokoro Prerelease Dependencies is optional. Please ignore the Kokoro Prerelease Dependencies check for now.

@parthea parthea changed the title improvement: add doc strings to explain the project ID format docs(samples): add doc strings to explain the project ID format Aug 6, 2022
@parthea parthea merged commit 7009724 into main Aug 6, 2022
@parthea parthea deleted the improv/add-doc branch August 6, 2022 01:59
@release-please release-please bot mentioned this pull request Aug 6, 2022
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@arbrown arbrown arbrown approved these changes

@arithmetic1728 arithmetic1728 Awaiting requested review from arithmetic1728

@nicain nicain Awaiting requested review from nicain nicain was automatically assigned from googleapis/python-samples-owners

@parthea parthea Awaiting requested review from parthea

Assignees
No one assigned
Labels
api: monitoring Issues related to the googleapis/python-monitoring API. size: s Pull request size is small.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@Shabirmean @parthea @arbrown @yoshi-kokoro