Fill gaps in image encoding documentation, fix how python documents union variants #4988
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
Wumpf
added
📖 documentation
emilk
approved these changes
Feb 1, 2024
Comment on lines
+40
to
+44
| * "Radians": | ||
| 3D rotation angle in radians. Only one of `degrees` or `radians` should be set. | ||
|
|
||
| * "Degrees": | ||
| 3D rotation angle in degrees. Only one of `degrees` or `radians` should be set. |
There was a problem hiding this comment.
Did you check how this looks in the generated python docs?
There was a problem hiding this comment.
Yep, that's the reason I leave so much space because otherwise it doesn't look great. This is what it looks like with the changes from this PR:
There was a problem hiding this comment.
hmm actually could still be better. the "only one of should be set" is a bit confusing ion this case, but then I also find the entire pattern a bit confusing 🤷
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.
What
Turned out union documentation didn't look great so I improved this a bit
Checklist
mainbuild: app.rerun.ionightlybuild: app.rerun.io