Document all public item in re_types
#6146
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
emilk
added
📖 documentation
Deployed docs
|
Wumpf
approved these changes
Apr 29, 2024
| define_coordinates!(LEFT_HAND_Y_DOWN => (Right, Down, Back)); | ||
| define_coordinates!(LEFT_HAND_Z_UP => (Right, Back, Up)); | ||
| define_coordinates!(LEFT_HAND_Z_DOWN => (Right, Forward, Down)); | ||
| define_coordinates!("X=Up, Y=Left, Z=Forward", ULF => (Up, Left, Forward)); |
There was a problem hiding this comment.
oof, the macro wasn't able to extract that?
jleibs
reviewed
Apr 29, 2024
jleibs
approved these changes
Apr 29, 2024
Co-authored-by: Jeremy Leibs <jeremy@rerun.io>
Co-authored-by: Andreas Reich <andreas@rerun.io>
Co-authored-by: Jeremy Leibs <jeremy@rerun.io>
emilk
force-pushed
the
emilk/document-re_types
branch
from
b507071
to
f4c1686
Compare
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
This is our public API, and keeping it well-documented seems like a low bar.
In some places it may seem unnecessary (e.g. describing what a
newfunction does, or whatAngle::Degreesmeans), but enforcing#[allow(missing_docs)]is the only way I know to remind us (and other contributors) to always consider documentation.You can opt-out using
#![allow(missing_docs)].While fixing the docs I found a few weird pieces of code that I also fixed.
Before
After
Checklist
mainbuild: rerun.io/viewernightlybuild: rerun.io/viewerTo run all checks from
main, comment on the PR with@rerun-bot full-check.