Adding more comments #34
Open
Conversation
This file contains hidden or 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
This comment was marked as outdated.
This comment was marked as outdated.
|
If this included what unit the property is in, this would be great! |
Contributor
Author
|
Most of them did have the units I thought, did you mean specifying pose was in meters? |
|
I mean specifying between radians, degrees, etc. and whether a timestamp is in seconds, milliseconds, or microseconds. The limelight documentation is missing a lot of information about specific units, leaving us having to guess. |
Contributor
Author
|
I thought I had done that, is there any specific ones I'm missing? |
|
I hadn't read much of your pr when I posted that comment. It was more a reason for having this and another reason it's useful. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
With this PR I'm going to try and write docstrings for most (if not every) field in the various classes such as
PoseEstimateorLimelightResults. I often find myself wondering what a specific property means and try to hover over it and see the docstring, but realize there isn't one.