Skip to content

Add docstrings for memory channel classes#3465

Merged
CoolCat467 merged 6 commits into
python-trio:mainfrom
Madhur-7568:docs-3221-remaining
Jul 12, 2026
Merged

Add docstrings for memory channel classes#3465
CoolCat467 merged 6 commits into
python-trio:mainfrom
Madhur-7568:docs-3221-remaining

Conversation

@Madhur-7568

Copy link
Copy Markdown
Contributor

Summary

Add class docstrings for:

  • MemorySendChannel
  • MemoryReceiveChannel
  • MemoryChannelStatistics

This improves the generated API documentation for these classes.

@A5rocks A5rocks left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please appease CI! I'm not too sure about these new docstrings. I'm not sure my review comments are correct, but I think they would be more useful to readers at least.

Comment thread src/trio/_channel.py Outdated
Comment thread src/trio/_channel.py Outdated
Comment thread src/trio/_channel.py Outdated
@A5rocks A5rocks added skip newsfragment Newsfragment is not required docs labels Jul 3, 2026

@A5rocks A5rocks left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the changes. Just a couple nitpicks!

Comment thread src/trio/_channel.py Outdated
Comment thread src/trio/_channel.py
Comment thread src/trio/_channel.py Outdated
@codecov

codecov Bot commented Jul 4, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00000%. Comparing base (865b7fc) to head (cbfea11).

Additional details and impacted files
@@               Coverage Diff               @@
##                 main        #3465   +/-   ##
===============================================
  Coverage   100.00000%   100.00000%           
===============================================
  Files             128          128           
  Lines           19417        19423    +6     
  Branches         1317         1317           
===============================================
+ Hits            19417        19423    +6     
Files with missing lines Coverage Δ
src/trio/_channel.py 100.00000% <100.00000%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Madhur-7568

Copy link
Copy Markdown
Contributor Author

I've made all the changes. Please review when you have time. Thanks!

@Madhur-7568

Copy link
Copy Markdown
Contributor Author

Hi! Thanks again for reviewing and approving the PR. Just wanted to check if there's anything else needed from my side before it can be merged. Thanks!

@A5rocks

A5rocks commented Jul 11, 2026

Copy link
Copy Markdown
Contributor

Nothing else is necessary from you, I'm just waiting for someone else to approve/merge.

@CoolCat467 CoolCat467 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"for python objects" seemed a little weird but I can't think of a better description myself, looks good.

@CoolCat467 CoolCat467 merged commit 5a5111b into python-trio:main Jul 12, 2026
44 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs skip newsfragment Newsfragment is not required

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants