Fix and tidy up ClusterNodeGenerator docstring #1516
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
- added notes on the valid range for `lam`, and the specific criteria that `q` must divide into the number of clusters, which might otherwise be unclear/non-obvious to the end-user - added information on default values of each parameter - minor formatting fixes
|
Code Climate has analyzed commit 51917c7 and detected 0 issues on this pull request. View more on Code Climate. |
kjun9
approved these changes
May 6, 2020
There was a problem hiding this comment.
Looks great, thanks for the fix!
Just FYI some context around putting the default value in the docstrings - we haven't been enforcing any particular rules around putting the default value of arguments as part of the docstring, since it does show up as part of method signature in the docs already:
And that will always be up to date, whereas the value in the docstring can get outdated by mistake.
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.
Attempts to resolve #1515
qmust be a int, not a floatlam, and the specific criteriathat
qmust divide into the number of clusters, which might otherwisebe unclear/non-obvious to the end-user