docs: fix formatting of request arg in docstring #1628
Merged
Conversation
This file contains 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
parthea
force-pushed
the
fix-request-formatting
branch
from
e7916ff
to
e3a3ab5
Compare
product-auto-label
bot
added
size: m
parthea
changed the title
parthea
force-pushed
the
fix-request-formatting
branch
2 times, most recently
from
e3a3ab5
to
140e6c4
Compare
parthea
force-pushed
the
fix-request-formatting
branch
from
bd43f00
to
108fafa
Compare
1 task
parthea
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
parthea
added
the
owlbot:run
gcf-owl-bot
bot
removed
the
owlbot:run
dizcology
reviewed
Mar 20, 2023
| @@ -233,7 +233,7 @@ async def sample_list_buckets(): | |||
|
|
|||
| Args: | |||
| request (Optional[Union[google.cloud.logging_v2.types.ListBucketsRequest, dict]]): | |||
| The request object. The parameters to `ListBuckets`. | |||
| The request object. The parameters to ``ListBuckets``. | |||
There was a problem hiding this comment.
The issue to be fixed by this PR seems to be about spacing - are these additional backticks intentional side effects? Will this cause issues with downstream documentation page generation?
There was a problem hiding this comment.
I don't expect any issues as we're using the same code a few lines down. There will be changes in downstream documentation pages but I believe in most cases it will be an improvement as previously lists were not being displayed properly. We can roll back this change if we encounter a significant issue downstream.
dizcology
approved these changes
Mar 20, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #1627 🦕