Fix contradicting argument name in .sample() documentation (n -> k) #635
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
davidwagner
approved these changes
May 20, 2025
Member
|
Looks reasonable to me, but I'd like to wait until we get the continuous integration fixed so we can be sure the tests are passing, before I merge this. Sorry about the delay, and thank you for the pull request. |
adnanhemani
reviewed
May 24, 2025
| @@ -6488,4 +6488,4 @@ | |||
| }, | |||
| "nbformat": 4, | |||
| "nbformat_minor": 2 | |||
| } | |||
Member
There was a problem hiding this comment.
nit: Ideally we should revert this change.
Member
|
@Omarr-kh can you please fix the nit and repush? I believe the CI/CD should be fixed now! |
Contributor
Author
|
@adnanhemani It should be fixed now. |
adnanhemani
approved these changes
May 27, 2025
Member
adnanhemani
left a comment
adnanhemani
left a comment
There was a problem hiding this comment.
LGTM - thank you for this change!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 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.
Fixes #625
[ ] Wrote test for feature
[ ] Added changes to CHANGELOG.md
Changes proposed:
This PR fixes a documentation inconsistency in the .sample() method. The argument name in the documentation was listed as n, which contradicts the actual function signature and docstring that use k.