Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve the proto docs to reflect the connection between the oneof fields #470

Open
viacheslav-rostovtsev opened this issue Jun 17, 2020 · 1 comment
Open

Improve the proto docs to reflect the connection between the oneof fields #470

viacheslav-rostovtsev opened this issue Jun 17, 2020 · 1 comment
Labels
type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.

Comments

@viacheslav-rostovtsev
Copy link
Member

Protos allow some fields to be connected in what essentially are the oneof groups. Assigning one field in the group will essentially prevent others from being assigned and there might be more of these behaviours. Docs currently do not reflect that and they should.
Merged
@yoshi-automation yoshi-automation added the triage me I really want to be triaged. label Jun 18, 2020
@dazuma dazuma added priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design. and removed triage me I really want to be triaged. priority: p2 Moderately-important priority. Fix may not be included in next release. type: bug Error or flaw in code with unintended results or allowing sub-optimal usage patterns. labels Jun 19, 2020
@dazuma dazuma mentioned this issue Jun 19, 2020
Merged
@viacheslav-rostovtsev
Copy link
Member Author

Also: document that proto3_optional fields have their has_foo? methods and that oneofs have to check presence via the oneof fields

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
type: feature request ‘Nice-to-have’ improvement, new feature or different behavior or design.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dazuma @yoshi-automation @viacheslav-rostovtsev