Skip to content

"builtins" module should link to Built-in Types and Built-in Exceptions #99030

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

Closed
wjandrea opened this issue Nov 2, 2022 · 1 comment
Closed
Labels
docs Documentation in the Doc dir

Comments

@wjandrea
Copy link
Contributor

wjandrea commented Nov 2, 2022

The builtins module documentation links to Built-in Functions and Built-in Constants, but not Built-in Types and Built-in Exceptions. Those should be included, shouldn't they?


I'd be happy to submit a PR for this, though I'm not very good with RST. I believe the links would be :ref:`bltin-types` and :ref:`bltin-exceptions`.

I'd also want to change the wording to make it less clunky with more links, from See ... for documentation. to For documentation, see ...

Linked PRs

@rruuaanng
Copy link
Contributor

rruuaanng commented Sep 9, 2024

I have submitted a PR, but I don't know if it is what you need

The builtins module documentation links to Built-in Functions and Built-in Constants, but not Built-in Types and Built-in Exceptions. Those should be included, shouldn't they?

I'd be happy to submit a PR for this, though I'm not very good with RST. I believe the links would be :ref:`bltin-types` and :ref:`bltin-exceptions`.

I'd also want to change the wording to make it less clunky with more links, from See ... for documentation. to For documentation, see ...

Linked PRs

* [gh-99030: Added documentation links for types and exceptions #123857](https://github.com/python/cpython/pull/123857)

I have submitted a PR, But I don't know if it is what you need.

willingc pushed a commit that referenced this issue Oct 21, 2024
* Added documentation links for types and exceptions

* Shortened description sentences

* Change content

* Change documentation

* Move seealso

* Add a spaces
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 21, 2024
…ythonGH-123857)

* Added documentation links for types and exceptions

* Shortened description sentences

* Change content

* Change documentation

* Move seealso

* Add a spaces
(cherry picked from commit 9256be7)

Co-authored-by: RUANG (Roy James) <longjinyii@outlook.com>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Oct 21, 2024
…ythonGH-123857)

* Added documentation links for types and exceptions

* Shortened description sentences

* Change content

* Change documentation

* Move seealso

* Add a spaces
(cherry picked from commit 9256be7)

Co-authored-by: RUANG (Roy James) <longjinyii@outlook.com>
willingc pushed a commit that referenced this issue Oct 21, 2024
…H-123857) (#125764)

gh-99030: Added documentation links for types and exceptions (GH-123857)

* Added documentation links for types and exceptions

* Shortened description sentences

* Change content

* Change documentation

* Move seealso

* Add a spaces
(cherry picked from commit 9256be7)

Co-authored-by: RUANG (Roy James) <longjinyii@outlook.com>
willingc pushed a commit that referenced this issue Oct 21, 2024
…H-123857) (GH-125765)

gh-99030: Added documentation links for types and exceptions (GH-123857)

* Added documentation links for types and exceptions

* Shortened description sentences

* Change content

* Change documentation

* Move seealso

* Add a spaces
(cherry picked from commit 9256be7)

Co-authored-by: RUANG (Roy James) <longjinyii@outlook.com>
ebonnal pushed a commit to ebonnal/cpython that referenced this issue Jan 12, 2025
…ythonGH-123857)

* Added documentation links for types and exceptions

* Shortened description sentences

* Change content

* Change documentation

* Move seealso

* Add a spaces
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation in the Doc dir
Projects
None yet
Development

No branches or pull requests

3 participants