Add documentation for gzyarp::DeviceRegistry class #231
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
xela-95
approved these changes
Feb 5, 2025
There was a problem hiding this comment.
Thanks @traversaro this was surely needed! I agree that we can further enhance the readability of this class in a future PR. I left just some nits in the documentation.
Co-authored-by: Alessandro Croci <[email protected]>
|
Thanks! |
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.
I was looking into this class to solve #159 (comment), but I realized that I did not remember anything. I went trough the class to document it to recall the details of the class. I am not in love of the use of both "device id" and "device database key" to refer to the same quantity, but I do not want to change API methods in this PR.