Add docstrings for ParkingLot.broken_by and HasFileno.fileno#3470
Open
krrishapatel wants to merge 4 commits into
Open
Add docstrings for ParkingLot.broken_by and HasFileno.fileno#3470krrishapatel wants to merge 4 commits into
krrishapatel wants to merge 4 commits into
Conversation
Addresses the remaining unchecked items from python-trio#3221: - ParkingLot.broken_by: documents the list of tasks that broke the lot - HasFileno.fileno: documents the protocol method
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #3470 +/- ##
===============================================
Coverage 100.00000% 100.00000%
===============================================
Files 128 128
Lines 19423 19424 +1
Branches 1317 1317
===============================================
+ Hits 19423 19424 +1
🚀 New features to boost your workflow:
|
Contributor
|
CI is failing? |
Author
|
CI note: the newsfragment check should pass now (added in the second commit). The formatting and RTD failures appear unrelated to my change — happy to investigate if they persist on re-run. |
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.
Addresses the remaining unchecked items from #3221:
trio.lowlevel.ParkingLot.broken_by: documents the attribute as the list of tasks that broke the lot viabreak_lot()trio._subprocess.HasFileno.fileno: adds a docstring to the protocol methodFollows the same inline attribute docstring pattern used in #3465.