Improve comprehensiveness of first docstring - #1789
Merged
Merged
Conversation
sogaiu
force-pushed
the
update-first-docstring
branch
2 times, most recently
from
August 2, 2026 07:01
952b6c7 to
6292c5a
Compare
sogaiu
force-pushed
the
update-first-docstring
branch
from
August 2, 2026 07:05
6292c5a to
c8e0335
Compare
Member
|
Seems a bit verbose to me, but I suppose for such an important function it can be a bit longer. |
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.
This PR is an attempt to improve the comprehensiveness of the docstring for
firstbased on exploration and discussion at our Zulip instance [1].Highlights for the candidate in this PR include:
nilis returned for other casesThanks to all discussion participants. Hopefully this PR is seen as acceptable 🤞
[1] Discussion is mostly between here and here.