Skip to content

Fix Sphinx warnings in re library docs#107044

Merged
AlexWaygood merged 2 commits intopython:mainfrom
wulmer:fix-sphinx-warnings-in-library-re-docs
Jul 22, 2023
Merged

Fix Sphinx warnings in re library docs#107044
AlexWaygood merged 2 commits intopython:mainfrom
wulmer:fix-sphinx-warnings-in-library-re-docs

Conversation

@wulmer
Copy link
Contributor

@wulmer wulmer commented Jul 22, 2023 •
edited by github-actions bot
Loading

As addition to PR #106995 this PR fixes the remaining Sphinx warnings.

There are two issues:

  1. Missing re.U definition
  2. Reference on C function scanf

For 2., I chose to use exclamation mark to disable the reference link, but I am not sure if scanf should be included into #106948.

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

@bedevere-bot bedevere-bot added awaiting review docs Documentation in the Doc dir skip news labels Jul 22, 2023
@methane
Copy link
Member

methane commented Jul 22, 2023

LGTM. But I wait for another review from better English writer before merge.

@AlexWaygood AlexWaygood merged commit 149748e into python:main Jul 22, 2023
@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Jul 22, 2023
@miss-islington
Copy link
Contributor

miss-islington commented Jul 22, 2023

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

@miss-islington
Copy link
Contributor

miss-islington commented Jul 22, 2023

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

@miss-islington
Copy link
Contributor

miss-islington commented Jul 22, 2023

Sorry, @wulmer and @AlexWaygood, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.
cherry_picker 149748ea4f552e6fe43a1d6d69bd65910a7c4813 3.11

@miss-islington
Copy link
Contributor

miss-islington commented Jul 22, 2023

Sorry @wulmer and @AlexWaygood, I had trouble checking out the 3.12 backport branch.
Please retry by removing and re-adding the "needs backport to 3.12" label.
Alternatively, you can backport using cherry_picker on the command line.
cherry_picker 149748ea4f552e6fe43a1d6d69bd65910a7c4813 3.12

@AlexWaygood AlexWaygood added needs backport to 3.12 only security fixes and removed needs backport to 3.12 only security fixes labels Jul 22, 2023
@miss-islington
Copy link
Contributor

miss-islington commented Jul 22, 2023

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

@bedevere-bot
Copy link

bedevere-bot commented Jul 22, 2023

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

@bedevere-bot bedevere-bot removed the needs backport to 3.12 only security fixes label Jul 22, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jul 22, 2023
@wulmer @miss-islington
Fix Sphinx warnings in re module docs (pythonGH-107044)
27fd8c0 
(cherry picked from commit 149748e)

Co-authored-by: wulmer <wulmer@users.noreply.github.com>
@AlexWaygood
Copy link
Member

AlexWaygood commented Jul 22, 2023

Ah, I see the conflict for the 3.11 backport is (at least partly) due to the fact that the .nitignore file doesn't exist on the 3.11 branch. That's somewhat annoying...

AlexWaygood pushed a commit that referenced this pull request Jul 22, 2023
@miss-islington @wulmer
[3.12] Fix Sphinx warnings in re module docs (GH-107044) (#107046)
844bdce 
Fix Sphinx warnings in `re` module docs (GH-107044)
(cherry picked from commit 149748e)

Co-authored-by: wulmer <wulmer@users.noreply.github.com>
@AlexWaygood
Copy link
Member

AlexWaygood commented Jul 22, 2023

@wulmer, are you able to take care of the 3.11 backport?

@wulmer
Copy link
Contributor Author

wulmer commented Jul 22, 2023

@wulmer, are you able to take care of the 3.11 backport?

@AlexWaygood : I think so. I have read the comments above about the cherry_picker command, do I have to use it? Or would it be ok to just commit to the 3.11 branch?

@AlexWaygood
Copy link
Member

AlexWaygood commented Jul 22, 2023

@wulmer, are you able to take care of the 3.11 backport?

@AlexWaygood : I think so. I have read the comments above about the cherry_picker command, do I have to use it? Or would it be ok to just commit to the 3.11 branch?

Either is absolutely fine :)

@bedevere-bot
Copy link

bedevere-bot commented Jul 22, 2023

GH-107055 is a backport of this pull request to the 3.11 branch.

@bedevere-bot bedevere-bot removed the needs backport to 3.11 only security fixes label Jul 22, 2023
@wulmer wulmer deleted the fix-sphinx-warnings-in-library-re-docs branch July 22, 2023 16:34
AlexWaygood pushed a commit that referenced this pull request Jul 22, 2023
@wulmer
[3.11] Fix Sphinx warnings in re module docs (GH-107044). (#107055)
b711441 
(cherry picked from commit 149748e)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@methane methane methane approved these changes

@serhiy-storchaka serhiy-storchaka serhiy-storchaka approved these changes

Assignees

@AlexWaygood AlexWaygood

Labels

docs Documentation in the Doc dir skip issue skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@wulmer @methane @miss-islington @bedevere-bot @AlexWaygood @serhiy-storchaka