Add documentation for statistics() and aclose() on memory channels
#3101
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3101 +/- ##
=============================================
Coverage 99.58338% 99.58338%
=============================================
Files 121 121
Lines 18002 18002
Branches 3248 3248
=============================================
Hits 17927 17927
Misses 52 52
Partials 23 23
|
|
pre-commit.ci autofix |
A5rocks
force-pushed
the
document-statistics
branch
from
443813e to
27aef3d
Compare
A5rocks
commented
Oct 5, 2024
| @@ -111,7 +111,7 @@ def __init__(self, max_buffer_size: int | float): # noqa: PYI041 | |||
|
|
|||
|
|
|||
| @attrs.frozen | |||
| class MemoryChannelStats: | |||
| class MemoryChannelStatistics: | |||
There was a problem hiding this comment.
I think this is backwards compatible as far as we care.
There was a problem hiding this comment.
If it wasn't publicaly re-exported originally, I would think this should count as backwards compatible, and if anyone does have issues we can tell them its their fault for digging into Trio's internals.
CoolCat467
approved these changes
Oct 6, 2024
jakkdl
reviewed
Oct 7, 2024
Comment on lines
+23
to
+24
| "No docstring found for class \"trio.MemoryChannelStatistics\"", | ||
| "No docstring found for class \"trio._channel.MemoryChannelStatistics\"", |
There was a problem hiding this comment.
I guess you could've added a docstring to the class at the same time to get rid of these as well
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.
I'm pretty sure the reason Sphinx isn't showing them is because they have no docstrings. Easy fix.
Mentioned on Gitter.