fix: list oneofs in docstring #1030
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
google-cla
bot
added
the
cla: yes
busunkim96
commented
Oct 13, 2021
Comment on lines
8
to
11
| This message has the following `oneof`_ fields (mutually exclusive fields). | ||
| For each oneof, at most one member field can be set at the same time. | ||
| Setting any member of the oneof automatically clears all other | ||
| members. |
There was a problem hiding this comment.
| @@ -512,13 +512,26 @@ class DeleteFeedRequest(proto.Message): | |||
| class OutputConfig(proto.Message): | |||
| r"""Output configuration for export assets destination. | |||
|
|
|||
| This message has the following `oneof`_ fields (mutually exclusive fields). | |||
There was a problem hiding this comment.
@dandhlee This is a concrete example of the new docstring with the oneof information.
There was a problem hiding this comment.
Will take a look, intuition tells me it'll just show up as `oneof`_
There was a problem hiding this comment.
Sadly it doesn't get parsed, but I'll be happy to include support for it C:
parthea
approved these changes
Oct 14, 2021
software-dov
approved these changes
Oct 14, 2021
atulep
reviewed
Oct 14, 2021
This was referenced Jan 18, 2022
This was referenced Jan 26, 2022
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 #713
FIeld attributes state which oneof they are part of.
If a message has a oneof with more than 1 member field, the docstring includes a short explanation of oneofs
and a list of the oneofs in the message.The list looks a bit odd in the generated docs (output of
nox -s docs/ what's published to googleapis.dev) - suggestions on better ways to present the information are very appreciated.@dandhlee Do you have an idea of how this docstring change would look in Cloud RAD?