Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Documentation: Remove incorrect role directive in graphlib.py #129892

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.

Sign up for GitHub

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

Jump to bottom
Closed
nikolasavic3 opened this issue Feb 9, 2025 · 1 comment · Fixed by #129896
Closed

Documentation: Remove incorrect role directive in graphlib.py #129892

nikolasavic3 opened this issue Feb 9, 2025 · 1 comment · Fixed by #129896
Labels
docs Documentation in the Doc dir easy stdlib Python modules in the Lib dir

Comments

@nikolasavic3
Copy link
Contributor

nikolasavic3 commented Feb 9, 2025 •
edited by bedevere-app bot
Loading

Documentation

Remove :exec: role directive from ValueError in TopologicalSorter.done() docstring since docstrings are not processed as reST contents.

Linked PRs
@nikolasavic3 nikolasavic3 added the docs Documentation in the Doc dir label Feb 9, 2025
@picnixz
Copy link
Member

picnixz commented Feb 9, 2025

Anyone is free to open a PR, but I would prefer that we just remove the role itself. We don't process docstrings as reST contents so this role is useless.

@picnixz picnixz added stdlib Python modules in the Lib dir easy labels Feb 9, 2025
@picnixz picnixz changed the title Documentation: Fix incorrect role directive in graphlib.py Documentation: Remove incorrect role directive in graphlib.py Feb 9, 2025
@nikolasavic3 nikolasavic3 mentioned this issue Feb 9, 2025
Merged
sobolevn pushed a commit that referenced this issue Feb 9, 2025
@nikolasavic3
gh-129892: Doc: Remove unnecessary role directive in graphlib.py (#12…
c537301 
…9896)

Change `:exec:ValueError` to `ValueError` in `TopologicalSorter.done()` docstring
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 9, 2025
@nikolasavic3 @miss-islington
pythongh-129892: Doc: Remove unnecessary role directive in graphlib.py (
524c848 
pythonGH-129896)

Change `:exec:ValueError` to `ValueError` in `TopologicalSorter.done()` docstring
(cherry picked from commit c537301)

Co-authored-by: Nikola Savic <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this issue Feb 9, 2025
@nikolasavic3 @miss-islington
pythongh-129892: Doc: Remove unnecessary role directive in graphlib.py (
d3ffbad 
pythonGH-129896)

Change `:exec:ValueError` to `ValueError` in `TopologicalSorter.done()` docstring
(cherry picked from commit c537301)

Co-authored-by: Nikola Savic <[email protected]>
This was referenced Feb 9, 2025
Merged
Merged
sobolevn pushed a commit that referenced this issue Feb 9, 2025
@miss-islington @nikolasavic3
[3.12] gh-129892: Doc: Remove unnecessary role directive in graphlib.…
23eccae 
…py (GH-129896) (#129905)

gh-129892: Doc: Remove unnecessary role directive in graphlib.py (GH-129896)

Change `:exec:ValueError` to `ValueError` in `TopologicalSorter.done()` docstring
(cherry picked from commit c537301)

Co-authored-by: Nikola Savic <[email protected]>
sobolevn pushed a commit that referenced this issue Feb 9, 2025
@miss-islington @nikolasavic3
[3.13] gh-129892: Doc: Remove unnecessary role directive in graphlib.…
26041da 
…py (GH-129896) (#129904)

gh-129892: Doc: Remove unnecessary role directive in graphlib.py (GH-129896)

Change `:exec:ValueError` to `ValueError` in `TopologicalSorter.done()` docstring
(cherry picked from commit c537301)

Co-authored-by: Nikola Savic <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
docs Documentation in the Doc dir easy stdlib Python modules in the Lib dir
Projects
docs issues
Status: Todo
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

gh-129892: Doc: Remove unnecessary role directive in graphlib.py nikolasavic3/cpython
2 participants
@picnixz @nikolasavic3