Repository navigation
Conversation
Contributor
|
Duplicate of #3523 |
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
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.
Resolves the two remaining checklist items of #3221 (
trio._subprocess.HasFileno.filenoandtrio.lowlevel.ParkingLot.broken_by). This also covers the remaining ground of #3406, whose memory-channel docstrings have already landed separately — the approach follows what was approved there.What
HasFileno.fileno: added a docstring describing the contract (return the file descriptor as an integer, which trio passes to the child process when aHasFilenoobject is used as stdio).ParkingLot.broken_by: documented via anAttributes:block in the class docstring (same pattern asMemoryChannelStatisticsfrom docs: add docstrings to memory channel classes #3406), because the field is a slotted attrs attribute and autodoc reads its docstring at runtime, where a PEP-224-style attribute docstring would not be visible.trio._subprocess.HasFileno.filenoentry from_check_type_completeness.json(the docstring makes pyright stop reporting it), and removedtrio.lowlevel.ParkingLot.broken_byfrom theUNDOCUMENTEDset indocs/source/conf.py, since it now renders through the class docstring.:exclude-members: broken_byto theParkingLotautoclass inreference-lowlevel.rst: with theAttributes:block plus:undoc-members:, the (still docstring-less at runtime) slotted field was rendered a second time as an empty entry, producing a duplicate-object-description warning.Verification
sphinx-build -nondocs/: zero warnings related to these members; both docstrings render (HasFileno.filenoinreference-io.html, thebroken_byattributes block inreference-lowlevel.html).check_type_completeness.pyruns cleanly against the updated JSON with respect to the touched symbols (the checker's output is pyright-version-dependent locally — the pre-existing baseline also reports unrelated drift — butHasFileno.filenonow resolves to a runtime docstring viainspect.getdoc, so the diagnostic is skipped exactly as the checker intends).ruff check/ruff format --checkclean on touched files.