Skip to content

gh-123492: Remove unnecessary :func: parentheses #123493

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
Merged
merged 5 commits into from
Aug 30, 2024
Merged

gh-123492: Remove unnecessary :func: parentheses #123493

merged 5 commits into from
Aug 30, 2024

Conversation

mattwang44
Copy link
Contributor

@mattwang44 mattwang44 commented Aug 30, 2024 •
edited by github-actions bot
Loading

Remove unnecessary :func: parentheses from reST content

📚 Documentation preview 📚: https://cpython-previews--123493.org.readthedocs.build/

@bedevere-app bedevere-app bot mentioned this pull request Aug 30, 2024
Closed
3 tasks
@Eclips4 Eclips4 requested review from AA-Turner and picnixz August 30, 2024 07:30
@picnixz
Copy link
Member

picnixz commented Aug 30, 2024

That's a lot of files to check. @AA-Turner do you think we can quickly make something with sphinx-lint for this? I'm currently busy on fixing exception errors (and cleaning up my office...)

@mattwang44
Copy link
Contributor Author

Please note that sphinx-lint CI only checks the Doc part. I can revert the changes in Lib and Misc (which reduce the number of updated files from 79 to 46) if you think they are unnecessary here.

@hugovk
Copy link
Member

hugovk commented Aug 30, 2024

That's a lot of files to check. @AA-Turner do you think we can quickly make something with sphinx-lint for this? I'm currently busy on fixing exception errors (and cleaning up my office...)

This PR is a result of adding it to Sphinx Lint :)

sphinx-contrib/sphinx-lint#115

Please note that sphinx-lint CI only checks the Doc part. I can revert the changes in Lib and Misc (which reduce the number of updated files from 79 to 46) if you think they are unnecessary here.

Let's keep Misc but revert the single Lib file: we can backport this PR to 3.13 and 3.12 but let's be extra cautious with 3.13 because it's in the release candidate phase.

hugovk
hugovk approved these changes Aug 30, 2024
View reviewed changes
Copy link
Member

@hugovk hugovk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@hugovk hugovk merged commit 103a047 into python:main Aug 30, 2024
23 checks passed
@hugovk hugovk added needs backport to 3.12 only security fixes needs backport to 3.13 bugs and security fixes labels Aug 30, 2024
@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

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

@miss-islington-app
Copy link

Sorry, @mattwang44 and @hugovk, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 103a0470e31d80d56097f57a27d97d7d2d3c9fbb 3.12

@miss-islington-app
Copy link

Sorry, @mattwang44 and @hugovk, I could not cleanly backport this to 3.13 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 103a0470e31d80d56097f57a27d97d7d2d3c9fbb 3.13

@hugovk
Copy link
Member

hugovk commented Aug 30, 2024

@mattwang44 Would you like to make the backport PRs?

@mattwang44
Copy link
Contributor Author

@mattwang44 Would you like to make the backport PRs?

ok let me handle this!

@mattwang44 mattwang44 deleted the fix-unnecessary-parentheses-in-rst-content branch August 30, 2024 11:50
mattwang44 added a commit to mattwang44/cpython that referenced this pull request Aug 30, 2024
@mattwang44
[3.12] pythongh-123492: Remove unnecessary :func: parentheses (pyth…
d04de79 
…ongh-123493)
@bedevere-app
Copy link

bedevere-app bot commented Aug 30, 2024

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

@bedevere-app bedevere-app bot removed the needs backport to 3.12 only security fixes label Aug 30, 2024
@bedevere-app
Copy link

bedevere-app bot commented Aug 30, 2024

GH-123513 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 Aug 30, 2024
hugovk pushed a commit that referenced this pull request Aug 30, 2024
@mattwang44
[3.12] gh-123492: Remove unnecessary :func: parentheses (gh-123493) (…
d5abd02 
…#123512)
hugovk pushed a commit that referenced this pull request Aug 30, 2024
@mattwang44
[3.13] gh-123492: Remove unnecessary :func: parentheses (gh-123493) (…
9f5f2b7 
…#123513)
@bedevere-bot
Copy link

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

Hi! The buildbot AMD64 Ubuntu NoGIL Refleaks 3.13 has failed when building commit 9f5f2b7.

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/1431/builds/418) and take a look at the build logs.
  4. Check if the failure is related to this commit (9f5f2b7) 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/1431/builds/418

Failed tests:

  • test_free_threading

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

==

Click to see traceback logs 
remote: Enumerating objects: 88, done.        
remote: Counting objects:   1% (1/88)        
remote: Counting objects:   2% (2/88)        
remote: Counting objects:   3% (3/88)        
remote: Counting objects:   4% (4/88)        
remote: Counting objects:   5% (5/88)        
remote: Counting objects:   6% (6/88)        
remote: Counting objects:   7% (7/88)        
remote: Counting objects:   9% (8/88)        
remote: Counting objects:  10% (9/88)        
remote: Counting objects:  11% (10/88)        
remote: Counting objects:  12% (11/88)        
remote: Counting objects:  13% (12/88)        
remote: Counting objects:  14% (13/88)        
remote: Counting objects:  15% (14/88)        
remote: Counting objects:  17% (15/88)        
remote: Counting objects:  18% (16/88)        
remote: Counting objects:  19% (17/88)        
remote: Counting objects:  20% (18/88)        
remote: Counting objects:  21% (19/88)        
remote: Counting objects:  22% (20/88)        
remote: Counting objects:  23% (21/88)        
remote: Counting objects:  25% (22/88)        
remote: Counting objects:  26% (23/88)        
remote: Counting objects:  27% (24/88)        
remote: Counting objects:  28% (25/88)        
remote: Counting objects:  29% (26/88)        
remote: Counting objects:  30% (27/88)        
remote: Counting objects:  31% (28/88)        
remote: Counting objects:  32% (29/88)        
remote: Counting objects:  34% (30/88)        
remote: Counting objects:  35% (31/88)        
remote: Counting objects:  36% (32/88)        
remote: Counting objects:  37% (33/88)        
remote: Counting objects:  38% (34/88)        
remote: Counting objects:  39% (35/88)        
remote: Counting objects:  40% (36/88)        
remote: Counting objects:  42% (37/88)        
remote: Counting objects:  43% (38/88)        
remote: Counting objects:  44% (39/88)        
remote: Counting objects:  45% (40/88)        
remote: Counting objects:  46% (41/88)        
remote: Counting objects:  47% (42/88)        
remote: Counting objects:  48% (43/88)        
remote: Counting objects:  50% (44/88)        
remote: Counting objects:  51% (45/88)        
remote: Counting objects:  52% (46/88)        
remote: Counting objects:  53% (47/88)        
remote: Counting objects:  54% (48/88)        
remote: Counting objects:  55% (49/88)        
remote: Counting objects:  56% (50/88)        
remote: Counting objects:  57% (51/88)        
remote: Counting objects:  59% (52/88)        
remote: Counting objects:  60% (53/88)        
remote: Counting objects:  61% (54/88)        
remote: Counting objects:  62% (55/88)        
remote: Counting objects:  63% (56/88)        
remote: Counting objects:  64% (57/88)        
remote: Counting objects:  65% (58/88)        
remote: Counting objects:  67% (59/88)        
remote: Counting objects:  68% (60/88)        
remote: Counting objects:  69% (61/88)        
remote: Counting objects:  70% (62/88)        
remote: Counting objects:  71% (63/88)        
remote: Counting objects:  72% (64/88)        
remote: Counting objects:  73% (65/88)        
remote: Counting objects:  75% (66/88)        
remote: Counting objects:  76% (67/88)        
remote: Counting objects:  77% (68/88)        
remote: Counting objects:  78% (69/88)        
remote: Counting objects:  79% (70/88)        
remote: Counting objects:  80% (71/88)        
remote: Counting objects:  81% (72/88)        
remote: Counting objects:  82% (73/88)        
remote: Counting objects:  84% (74/88)        
remote: Counting objects:  85% (75/88)        
remote: Counting objects:  86% (76/88)        
remote: Counting objects:  87% (77/88)        
remote: Counting objects:  88% (78/88)        
remote: Counting objects:  89% (79/88)        
remote: Counting objects:  90% (80/88)        
remote: Counting objects:  92% (81/88)        
remote: Counting objects:  93% (82/88)        
remote: Counting objects:  94% (83/88)        
remote: Counting objects:  95% (84/88)        
remote: Counting objects:  96% (85/88)        
remote: Counting objects:  97% (86/88)        
remote: Counting objects:  98% (87/88)        
remote: Counting objects: 100% (88/88)        
remote: Counting objects: 100% (88/88), done.        
remote: Compressing objects:   1% (1/87)        
remote: Compressing objects:   2% (2/87)        
remote: Compressing objects:   3% (3/87)        
remote: Compressing objects:   4% (4/87)        
remote: Compressing objects:   5% (5/87)        
remote: Compressing objects:   6% (6/87)        
remote: Compressing objects:   8% (7/87)        
remote: Compressing objects:   9% (8/87)        
remote: Compressing objects:  10% (9/87)        
remote: Compressing objects:  11% (10/87)        
remote: Compressing objects:  12% (11/87)        
remote: Compressing objects:  13% (12/87)        
remote: Compressing objects:  14% (13/87)        
remote: Compressing objects:  16% (14/87)        
remote: Compressing objects:  17% (15/87)        
remote: Compressing objects:  18% (16/87)        
remote: Compressing objects:  19% (17/87)        
remote: Compressing objects:  20% (18/87)        
remote: Compressing objects:  21% (19/87)        
remote: Compressing objects:  22% (20/87)        
remote: Compressing objects:  24% (21/87)        
remote: Compressing objects:  25% (22/87)        
remote: Compressing objects:  26% (23/87)        
remote: Compressing objects:  27% (24/87)        
remote: Compressing objects:  28% (25/87)        
remote: Compressing objects:  29% (26/87)        
remote: Compressing objects:  31% (27/87)        
remote: Compressing objects:  32% (28/87)        
remote: Compressing objects:  33% (29/87)        
remote: Compressing objects:  34% (30/87)        
remote: Compressing objects:  35% (31/87)        
remote: Compressing objects:  36% (32/87)        
remote: Compressing objects:  37% (33/87)        
remote: Compressing objects:  39% (34/87)        
remote: Compressing objects:  40% (35/87)        
remote: Compressing objects:  41% (36/87)        
remote: Compressing objects:  42% (37/87)        
remote: Compressing objects:  43% (38/87)        
remote: Compressing objects:  44% (39/87)        
remote: Compressing objects:  45% (40/87)        
remote: Compressing objects:  47% (41/87)        
remote: Compressing objects:  48% (42/87)        
remote: Compressing objects:  49% (43/87)        
remote: Compressing objects:  50% (44/87)        
remote: Compressing objects:  51% (45/87)        
remote: Compressing objects:  52% (46/87)        
remote: Compressing objects:  54% (47/87)        
remote: Compressing objects:  55% (48/87)        
remote: Compressing objects:  56% (49/87)        
remote: Compressing objects:  57% (50/87)        
remote: Compressing objects:  58% (51/87)        
remote: Compressing objects:  59% (52/87)        
remote: Compressing objects:  60% (53/87)        
remote: Compressing objects:  62% (54/87)        
remote: Compressing objects:  63% (55/87)        
remote: Compressing objects:  64% (56/87)        
remote: Compressing objects:  65% (57/87)        
remote: Compressing objects:  66% (58/87)        
remote: Compressing objects:  67% (59/87)        
remote: Compressing objects:  68% (60/87)        
remote: Compressing objects:  70% (61/87)        
remote: Compressing objects:  71% (62/87)        
remote: Compressing objects:  72% (63/87)        
remote: Compressing objects:  73% (64/87)        
remote: Compressing objects:  74% (65/87)        
remote: Compressing objects:  75% (66/87)        
remote: Compressing objects:  77% (67/87)        
remote: Compressing objects:  78% (68/87)        
remote: Compressing objects:  79% (69/87)        
remote: Compressing objects:  80% (70/87)        
remote: Compressing objects:  81% (71/87)        
remote: Compressing objects:  82% (72/87)        
remote: Compressing objects:  83% (73/87)        
remote: Compressing objects:  85% (74/87)        
remote: Compressing objects:  86% (75/87)        
remote: Compressing objects:  87% (76/87)        
remote: Compressing objects:  88% (77/87)        
remote: Compressing objects:  89% (78/87)        
remote: Compressing objects:  90% (79/87)        
remote: Compressing objects:  91% (80/87)        
remote: Compressing objects:  93% (81/87)        
remote: Compressing objects:  94% (82/87)        
remote: Compressing objects:  95% (83/87)        
remote: Compressing objects:  96% (84/87)        
remote: Compressing objects:  97% (85/87)        
remote: Compressing objects:  98% (86/87)        
remote: Compressing objects: 100% (87/87)        
remote: Compressing objects: 100% (87/87), done.        
remote: Total 88 (delta 1), reused 84 (delta 1), pack-reused 0 (from 0)        
From https://github.com/python/cpython
 * branch                  3.13       -> FETCH_HEAD
Note: switching to '9f5f2b712884bc2d366737eda7e69bc126269fd0'.

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 9f5f2b7128 [3.13] gh-123492: Remove unnecessary `:func:` parentheses (gh-123493) (#123513)
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:2264: buildbottest] Error 2

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@hugovk hugovk hugovk approved these changes

@AA-Turner AA-Turner Awaiting requested review from AA-Turner AA-Turner is a code owner

@picnixz picnixz Awaiting requested review from picnixz

Assignees

@hugovk hugovk

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mattwang44 @picnixz @hugovk @bedevere-bot