[Doc] Remove unnecessary quotes from typing module #137207
Conversation
…#106335) Remove private _PyThreadState and _PyInterpreterState C API functions: move them to the internal C API (pycore_pystate.h and pycore_interp.h). Don't export most of these functions anymore, but still export functions used by tests. Remove _PyThreadState_Prealloc() and _PyThreadState_Init() from the C API, but keep it in the stable API.
This reverts commit ebfa093.
|
This is a purely cosmetic change IMO, I see little benefit in removing the quotes. Have they caused confusion? |
Beautiful is better than ugly. 🙂 In fact, this is purely cosmetic. But the more common form in docs is without these quotes (in a fast search).
It doesn´t cause confusion per si, in an absolute way or a concrete case for now. It can cause confusion, mainly because they are inside crases, both documentation maintainers and translators as well. |
|
Aren't the quotes correct here because we're quoting the title of the work being referred to? |
It could be the author's intention, but it isn't the pattern. If it were true, we should put more quotes everywhere. I don't think it's a good idea. At the same module, we have 
When the link is all over the title, the docs style cares about the title being highlighted. I think it is enough and quotes are unnecessary (and ugly and more complicated to maintain). However, in the case of “Type System Reference” section of the mypy docs the link isn't about the title. I guess that is because the section hasn't been anchored in mypy docs (it is only a menu separator), so it is not possible to link it directly. Here, the quotes make sense. |
|
I agree with other reviewers on their comment. There are only two outcomes, we close this PR or accept it. I did a |
|
Thanks @adorilson for the PR, and @orsenthil for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13. |
|
Thanks @adorilson for the PR, and @orsenthil for merging it 🌮🎉.. I'm working now to backport this PR to: 3.14. |
* pythongh-106320: Remove private _PyInterpreterState functions (pythonGH-106335) Remove private _PyThreadState and _PyInterpreterState C API functions: move them to the internal C API (pycore_pystate.h and pycore_interp.h). Don't export most of these functions anymore, but still export functions used by tests. Remove _PyThreadState_Prealloc() and _PyThreadState_Init() from the C API, but keep it in the stable API. * Doc: minor change * Revert "Doc: minor change" This reverts commit ebfa093. * [Doc] Remove unnecessary quotes from typing (See Also section) * [Doc] Remove unnecessary quotes from typing --------- (cherry picked from commit f06fcb7) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com> Co-authored-by: Victor Stinner <vstinner@python.org>
* pythongh-106320: Remove private _PyInterpreterState functions (pythonGH-106335) Remove private _PyThreadState and _PyInterpreterState C API functions: move them to the internal C API (pycore_pystate.h and pycore_interp.h). Don't export most of these functions anymore, but still export functions used by tests. Remove _PyThreadState_Prealloc() and _PyThreadState_Init() from the C API, but keep it in the stable API. * Doc: minor change * Revert "Doc: minor change" This reverts commit ebfa093. * [Doc] Remove unnecessary quotes from typing (See Also section) * [Doc] Remove unnecessary quotes from typing --------- (cherry picked from commit f06fcb7) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com> Co-authored-by: Victor Stinner <vstinner@python.org>
|
GH-137540 is a backport of this pull request to the 3.13 branch. |
|
GH-137541 is a backport of this pull request to the 3.14 branch. |
…#137540) [Doc] Remove unnecessary quotes from typing module (GH-137207) * gh-106320: Remove private _PyInterpreterState functions (GH-106335) Remove private _PyThreadState and _PyInterpreterState C API functions: move them to the internal C API (pycore_pystate.h and pycore_interp.h). Don't export most of these functions anymore, but still export functions used by tests. Remove _PyThreadState_Prealloc() and _PyThreadState_Init() from the C API, but keep it in the stable API. * Doc: minor change * Revert "Doc: minor change" This reverts commit ebfa093. * [Doc] Remove unnecessary quotes from typing (See Also section) * [Doc] Remove unnecessary quotes from typing --------- (cherry picked from commit f06fcb7) Co-authored-by: Adorilson Bezerra <adorilson@gmail.com> Co-authored-by: Victor Stinner <vstinner@python.org>
📚 Documentation preview 📚: https://cpython-previews--137207.org.readthedocs.build/