Skip to content

gh-89554: Document _thread.LockType as a class#150684

Open
gaborbernat wants to merge 1 commit into
python:mainfrom
gaborbernat:gh-89554-thread-class-roles
Open

gh-89554: Document _thread.LockType as a class#150684
gaborbernat wants to merge 1 commit into
python:mainfrom
gaborbernat:gh-89554-thread-class-roles

Conversation

@gaborbernat
Copy link
Copy Markdown
Contributor

_thread.LockType is a class (the type of lock objects), but the documentation marks it with the .. data:: directive, so :class: cross-references to it cannot resolve against a py:class target.

Switch the entry to .. class::.

Refs: gh-89554. Documentation-only change, so no Misc/NEWS entry (skip news).

This file is not covered by CODEOWNERS, so cc @vstinner, who reviews most _thread changes.

_thread.LockType is a class (the type of lock objects), but was
documented with the ".. data::" directive, so ":class:" cross-references
to it cannot resolve against a py:class target.

Switch the entry to ".. class::".
@read-the-docs-community
Copy link
Copy Markdown

Documentation build overview

📚 cpython-previews | 🛠️ Build #32924550 | 📁 Comparing 9c3fc41 against main (2f8f569)

  🔍 Preview build  

1 file changed
± library/_thread.html

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

1 participant