-
-
Notifications
You must be signed in to change notification settings - Fork 30.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Incorrect use of the :class: role with the "()" suffix #120345
Comments
serhiy-storchaka
added
docs
Documentation in the Doc dir
3.12
bugs and security fixes
3.13
bugs and security fixes
3.14
new features, bugs and security fixes
labels
Jun 11, 2024
serhiy-storchaka
added a commit
to serhiy-storchaka/cpython
that referenced
this issue
Jun 11, 2024
…suffix * Remove "()" when refer to a class as a type. * Use :func: when refer to a callable. * Fix reference to the datetime.astimezone() method.
serhiy-storchaka
added a commit
that referenced
this issue
Jun 12, 2024
…GH-120347) * Remove "()" when refer to a class as a type. * Use :func: when refer to a callable. * Fix reference to the datetime.astimezone() method.
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Jun 12, 2024
…suffix (pythonGH-120347) * Remove "()" when refer to a class as a type. * Use :func: when refer to a callable. * Fix reference to the datetime.astimezone() method. (cherry picked from commit 92c9c6a) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
miss-islington
pushed a commit
to miss-islington/cpython
that referenced
this issue
Jun 12, 2024
…suffix (pythonGH-120347) * Remove "()" when refer to a class as a type. * Use :func: when refer to a callable. * Fix reference to the datetime.astimezone() method. (cherry picked from commit 92c9c6a) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Is this something that could be suggested for https://github.com/sphinx-contrib/sphinx-lint? And can this issue be closed? |
Among more than 9000 If you add a check in the linter, it will run in vain two years before catching the next error. |
mrahtz
pushed a commit
to mrahtz/cpython
that referenced
this issue
Jun 30, 2024
…suffix (pythonGH-120347) * Remove "()" when refer to a class as a type. * Use :func: when refer to a callable. * Fix reference to the datetime.astimezone() method.
noahbkim
pushed a commit
to hudson-trading/cpython
that referenced
this issue
Jul 11, 2024
…suffix (pythonGH-120347) * Remove "()" when refer to a class as a type. * Use :func: when refer to a callable. * Fix reference to the datetime.astimezone() method.
estyxx
pushed a commit
to estyxx/cpython
that referenced
this issue
Jul 17, 2024
…suffix (pythonGH-120347) * Remove "()" when refer to a class as a type. * Use :func: when refer to a callable. * Fix reference to the datetime.astimezone() method.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
There are several uses of the
:class:
role with the name followed by()
.This is incorrect. If we refer to a class as a type, we should not add
()
to the name. If we refer to it as a callable, we can use the:func:
role instead (which adds()
automatically). In one place:class:
was improperly used for not a class at all.Linked PRs
The text was updated successfully, but these errors were encountered: