Skip to content

docs(pylock): document select() method and PylockSelectError#1153

Merged
henryiii merged 1 commit intopypa:mainfrom
r266-tech:docs-pylock-select
Apr 9, 2026
Merged

docs(pylock): document select() method and PylockSelectError#1153
henryiii merged 1 commit intopypa:mainfrom
r266-tech:docs-pylock-select

Conversation

@r266-tech
Copy link
Copy Markdown
Contributor

Summary

PR #1092 added Pylock.select() and PylockSelectError but docs/pylock.rst was not updated.

This PR:

  • Adds select to the Pylock autoclass :members: directive so the method's docstring renders in the docs
  • Adds PylockSelectError to the exceptions section
  • Adds a brief usage example showing pylock.select() in the existing code block

Test plan

  • nox -s docs builds without warnings
  • select() method appears in the rendered Pylock class documentation
  • PylockSelectError appears in the exceptions section

@henryiii henryiii requested a review from sbidoul April 9, 2026 05:19
Copy link
Copy Markdown
Member

@sbidoul sbidoul left a comment

Choose a reason for hiding this comment

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

Thanks!

@r266-tech r266-tech force-pushed the docs-pylock-select branch from ae9fe41 to 6505238 Compare April 9, 2026 08:20
@henryiii henryiii merged commit af0026c into pypa:main Apr 9, 2026
55 checks passed
This was referenced Apr 13, 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.

3 participants