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

Skip to content

gh-129892: Doc: Remove unnecessary role directive in graphlib.py #129896

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

Merged
merged 2 commits into from
Feb 9, 2025

Conversation

nikolasavic3
Copy link
Contributor

@nikolasavic3 nikolasavic3 commented Feb 9, 2025

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

Fixes #129892

Change :exec:`ValueError` to ValueError in TopologicalSorter.done() docstring
@bedevere-app
Copy link

bedevere-app bot commented Feb 9, 2025

Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool.

If this change has little impact on Python users, wait for a maintainer to apply the skip news label instead.

@nikolasavic3 nikolasavic3 changed the title Doc: remove useless role in TopologicalSorter.done() docstring gh-129892: Doc: Remove unnecessary role directive in graphlib.py Feb 9, 2025
@picnixz
Copy link
Member

picnixz commented Feb 9, 2025

No need for merging main into your branch if nothing has changed and if the CI is not failing (or if the CI jobs were changed on main, usually you need to merge it again).

@sobolevn sobolevn added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Feb 9, 2025
@sobolevn
Copy link
Member

sobolevn commented Feb 9, 2025

This looks like a bug / typo in the docs, so I propose to backport this change.

@sobolevn sobolevn merged commit c537301 into python:main Feb 9, 2025
42 checks passed
@miss-islington-app
Copy link

Thanks @nikolasavic3 for the PR, and @sobolevn for merging it 🌮🎉.. I'm working now to backport this PR to: 3.12, 3.13.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 9, 2025
pythonGH-129896)

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

Co-authored-by: Nikola Savic <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 9, 2025

GH-129904 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Feb 9, 2025
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Feb 9, 2025
pythonGH-129896)

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

Co-authored-by: Nikola Savic <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Feb 9, 2025

GH-129905 is a backport of this pull request to the 3.12 branch.

@sobolevn
Copy link
Member

sobolevn commented Feb 9, 2025

Congrats on your first merged PR :)

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Feb 9, 2025
@nikolasavic3
Copy link
Contributor Author

Thank you! :)

@picnixz
Copy link
Member

picnixz commented Feb 9, 2025

This looks like a bug / typo in the docs, so I propose to backport this change.

Yes, I forgot to apply the labels, so thank you!

sobolevn pushed a commit that referenced this pull request Feb 9, 2025
…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 pull request Feb 9, 2025
…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]>
@nikolasavic3 nikolasavic3 deleted the patch-3 branch February 9, 2025 15:47
@bedevere-bot
Copy link

⚠️⚠️⚠️ Buildbot failure ⚠️⚠️⚠️

Hi! The buildbot aarch64 Fedora Stable Refleaks 3.13 has failed when building commit 26041da.

What do you need to do:

  1. Don't panic.
  2. Check the buildbot page in the devguide if you don't know what the buildbots are or how they work.
  3. Go to the page of the buildbot that failed (https://buildbot.python.org/#/builders/1512/builds/339) and take a look at the build logs.
  4. Check if the failure is related to this commit (26041da) or if it is a false positive.
  5. If the failure is related to this commit, please, reflect that on the issue and make a new Pull Request with a fix.

You can take a look at the buildbot page here:

https://buildbot.python.org/#/builders/1512/builds/339

Failed tests:

  • test.test_multiprocessing_spawn.test_processes

Test leaking resources:

  • test_processes: references
  • test_processes: memory blocks

Summary of the results of the build (if available):

==

Click to see traceback logs
remote: Enumerating objects: 4, done.        
remote: Counting objects:  33% (1/3)        
remote: Counting objects:  66% (2/3)        
remote: Counting objects: 100% (3/3)        
remote: Counting objects: 100% (3/3), done.        
remote: Total 4 (delta 2), reused 2 (delta 2), pack-reused 1 (from 1)        
From https://github.com/python/cpython
 * branch                    3.13       -> FETCH_HEAD
Note: switching to '26041daf01742cf263c5de34dd243cfaa5936035'.

You are in 'detached HEAD' state. You can look around, make experimental
changes and commit them, and you can discard any commits you make in this
state without impacting any branches by switching back to a branch.

If you want to create a new branch to retain commits you create, you may
do so (now or later) by using -c with the switch command. Example:

  git switch -c <new-branch-name>

Or undo this operation with:

  git switch -

Turn off this advice by setting config variable advice.detachedHead to false

HEAD is now at 26041daf017 [3.13] gh-129892: Doc: Remove unnecessary role directive in graphlib.py (GH-129896) (#129904)
Switched to and reset branch '3.13'

configure: WARNING: no system libmpdecimal found; falling back to bundled libmpdecimal (deprecated and scheduled for removal in Python 3.15)

make: *** [Makefile:2217: buildbottest] Error 2

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

Successfully merging this pull request may close these issues.

Documentation: Remove incorrect role directive in graphlib.py
4 participants