Skip to content

gh-112316: Further improve docs for inspect.signature and inspect.Signature#112631

Merged
hauntsaninja merged 5 commits into
python:mainfrom
AlexWaygood:more-Signature-docs
Dec 3, 2023
Merged

gh-112316: Further improve docs for inspect.signature and inspect.Signature#112631
hauntsaninja merged 5 commits into
python:mainfrom
AlexWaygood:more-Signature-docs

Conversation

@AlexWaygood

@AlexWaygood AlexWaygood commented Dec 2, 2023 •
edited
Loading

Copy link
Copy Markdown
Member
  • Use the .. doctest:: and .. testcode:: directives to test code snippets in CI
  • Fix errors in the code snippets that are now tested in CI
  • Improve markup in a few places
  • Fix a few typos and minor grammar issues

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

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Dec 2, 2023
@bedevere-app bedevere-app Bot mentioned this pull request Dec 2, 2023
Closed
@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 2, 2023
@AlexWaygood AlexWaygood marked this pull request as ready for review December 2, 2023 23:34
hugovk
hugovk approved these changes Dec 3, 2023
View reviewed changes

@hugovk hugovk left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks!

@hauntsaninja hauntsaninja merged commit fc9e24b into python:main Dec 3, 2023
@miss-islington-app

miss-islington-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

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

@miss-islington-app

miss-islington-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

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

cherry_picker fc9e24b01fb7da4160b82cef26981d72bb678c13 3.12

@miss-islington-app

miss-islington-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

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

cherry_picker fc9e24b01fb7da4160b82cef26981d72bb678c13 3.11

@hauntsaninja hauntsaninja removed needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 3, 2023
@AlexWaygood AlexWaygood deleted the more-Signature-docs branch December 3, 2023 10:22
@bedevere-app

bedevere-app Bot commented Dec 3, 2023

Copy link
Copy Markdown

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

@AlexWaygood

AlexWaygood commented Dec 3, 2023

Copy link
Copy Markdown
Member Author

I'll backport #112649 to 3.11 rather than backporting this PR to 3.11.

AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Dec 3, 2023
@AlexWaygood
[3.12] pythongh-112316: improve docs for inspect.signature and `ins…
f7a0f02 
…pect.Signature` (python#112631)

(cherry-picked from commit fc9e24b)
AlexWaygood added a commit that referenced this pull request Dec 3, 2023
@AlexWaygood
[3.12] gh-112316: improve docs for inspect.signature and `inspect.S…
6221482 
…ignature` (#112631) (#112649)

(cherry-picked from commit fc9e24b)
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Dec 3, 2023
@AlexWaygood @miss-islington
[3.12] pythongh-112316: improve docs for inspect.signature and `ins…
52d1777 
…pect.Signature` (pythonGH-112631) (pythonGH-112649)

(cherry-picked from commit fc9e24b)
(cherry picked from commit 6221482)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
AlexWaygood added a commit that referenced this pull request Dec 3, 2023
@miss-islington @AlexWaygood
[3.11] [3.12] gh-112316: improve docs for inspect.signature and `in…
6ab6c85 
…spect.Signature` (GH-112631) (GH-112649) (#112652)

[3.12] gh-112316: improve docs for `inspect.signature` and `inspect.Signature` (GH-112631) (GH-112649)

(cherry-picked from commit fc9e24b)
(cherry picked from commit 6221482)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@AlexWaygood @aisk
pythongh-112316: improve docs for inspect.signature and `inspect.Si…
674b7b3 
…gnature` (python#112631)
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@AlexWaygood @Glyphack
pythongh-112316: improve docs for inspect.signature and `inspect.Si…
939a86f 
…gnature` (python#112631)
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
@hauntsaninja hauntsaninja hauntsaninja approved these changes
@sobolevn sobolevn Awaiting requested review from sobolevn

Assignees

@hauntsaninja hauntsaninja

Labels

docs Documentation in the Doc dir skip news

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@AlexWaygood @hugovk @hauntsaninja