pybricks.hubs: add top/front side explanation to docstrings of Hub constructors#171
Closed
kai-morich wants to merge 1 commit into
Closed
pybricks.hubs: add top/front side explanation to docstrings of Hub constructors#171kai-morich wants to merge 1 commit into
kai-morich wants to merge 1 commit into
Conversation
kai-morich
changed the title
Contributor
Author
|
was already visible in VS Code tooltips in the function description, so no need to duplicate to parameter description |
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
1 participant
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.
The top_side / front_side parameters at the Hub constructors were difficult to understand. Was obvious after reading https://github.com/orgs/pybricks/discussions/2402. Then I also noticed the explanation e.g. (with the buttons) in the documentation.
By adding to docstrings this explanation is also available with VS Code parameter tool tips.