docs(providers): add comprehensive __init__ parameter documentation for OdomProvider#1644
Merged
openminddev merged 2 commits intoOpenMind:mainfrom Jan 18, 2026
Merged
Conversation
Refactored the OdomProvider class docstring to provide clearer and more concise parameter descriptions for URID, use_zenoh, and channel. Removed redundant notes and implementation details to improve readability.
aydnOktay
pushed a commit
to aydnOktay/OM1
that referenced
this pull request
Jan 19, 2026
…or OdomProvider (OpenMind#1644) * docs(providers): add comprehensive __init__ parameter documentation for OdomProvider * Simplify and clarify OdomProvider docstring parameters Refactored the OdomProvider class docstring to provide clearer and more concise parameter descriptions for URID, use_zenoh, and channel. Removed redundant notes and implementation details to improve readability. --------- Co-authored-by: openmindev <boyuan.eth@gmail.com>
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
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.
added missing parameter docs for odomprovider init method.
details:
replaces single-line docstring with complete numpy-style documentation.