Skip to content

Add SocketStream method docstrings - #3489

Closed
mmaxjr wants to merge 2 commits into
python-trio:mainfrom
mmaxjr:docs-socketstream-method-docstrings
Closed

Add SocketStream method docstrings#3489
mmaxjr wants to merge 2 commits into
python-trio:mainfrom
mmaxjr:docs-socketstream-method-docstrings

Conversation

@mmaxjr

@mmaxjr mmaxjr commented Aug 8, 2026

Copy link
Copy Markdown

Summary

Fixes #3221.

Tests

  • py -3.14 -m py_compile src\trio\_highlevel_socket.py
  • Runtime docstring smoke check for SocketStream methods
  • py -3.14 -m pytest src/trio/_tests/test_highlevel_open_tcp_stream.py -q
  • git diff --check

@mmaxjr
mmaxjr marked this pull request as ready for review August 8, 2026 14:03
@A5rocks

A5rocks commented Aug 8, 2026

Copy link
Copy Markdown
Contributor

Not necessary since these do not show up in the docs. Anyways please do not generate PR descriptions with an LLM in the future!

@A5rocks A5rocks closed this Aug 8, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Some functions and properties in the documentation have no docstring

2 participants