Skip to content

docs: add missing API docstrings#3469

Closed
w3lld1 wants to merge 1 commit into
python-trio:mainfrom
w3lld1:docs-channel-docstrings
Closed

docs: add missing API docstrings#3469
w3lld1 wants to merge 1 commit into
python-trio:mainfrom
w3lld1:docs-channel-docstrings

Conversation

@w3lld1

@w3lld1 w3lld1 commented Jul 10, 2026

Copy link
Copy Markdown

Summary

Fixes #3221

Test plan

  • black --check src/trio/_channel.py src/trio/_subprocess.py docs/source/conf.py
  • python -m pytest src/trio/_tests/test_channel.py -q
  • make -C docs html SPHINXOPTS='-W --keep-going'

@w3lld1 w3lld1 force-pushed the docs-channel-docstrings branch from bbcca63 to ac6d1f4 Compare July 10, 2026 00:48
@w3lld1

w3lld1 commented Jul 10, 2026

Copy link
Copy Markdown
Author

Updated the type completeness allowlist after CI showed the newly documented channel classes and HasFileno.fileno entries are now resolved.

Local validation:

  • python3 -m tox -m check --override testenv:gen_exports.base_python=python3 --override testenv:pip_compile.base_python=python3 --override testenv:type_completeness.base_python=python3

Note: local validation used python3 overrides because Python 3.13 is not installed in this runner; CI will still run the repository's normal Python 3.13 configuration.

@A5rocks

A5rocks commented Jul 10, 2026

Copy link
Copy Markdown
Contributor

This has already been partly solved by an existing PR

@A5rocks A5rocks closed this Jul 10, 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