◐ Shell
reader mode source ↗
Skip to content

gh-101100: Improve documentation on function attributes#112933

Merged
hugovk merged 4 commits into
python:mainfrom
AlexWaygood:function-attr-docs
Dec 11, 2023
Merged

gh-101100: Improve documentation on function attributes#112933
hugovk merged 4 commits into
python:mainfrom
AlexWaygood:function-attr-docs

Conversation

@AlexWaygood

@AlexWaygood AlexWaygood commented Dec 10, 2023 •
edited
Loading

Copy link
Copy Markdown
Member

Theoretically, I could have kept the table as an old-style ASCII-art Sphinx table. But nearly every line was being changed anyway, so I figured I would update it to use the .. list-table syntax while I was here.

This gets us down to 11 Sphinx warnings in the datamodel docs.

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

@bedevere-app bedevere-app Bot added docs Documentation in the Doc dir skip news labels Dec 10, 2023
@bedevere-app bedevere-app Bot mentioned this pull request Dec 10, 2023
Open
@AlexWaygood AlexWaygood marked this pull request as ready for review December 10, 2023 14:35
hugovk
hugovk approved these changes Dec 11, 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.

Hide comment

🧹📔📕📖📗📚📘📙📚📓📕🧹

@hugovk

hugovk commented Dec 11, 2023

Copy link
Copy Markdown
Member

And backport?

@AlexWaygood @hugovk
. …
9a8515e 
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@AlexWaygood AlexWaygood added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Dec 11, 2023
@hugovk hugovk merged commit 4c5b9c1 into python:main Dec 11, 2023
@miss-islington-app

miss-islington-app Bot commented Dec 11, 2023

Copy link
Copy Markdown

Thanks @AlexWaygood for the PR, and @hugovk 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 11, 2023

Copy link
Copy Markdown

Sorry, @AlexWaygood 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 4c5b9c107a1d158b245f21a1839a2bec97d05383 3.12

@miss-islington-app

miss-islington-app Bot commented Dec 11, 2023

Copy link
Copy Markdown

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

cherry_picker 4c5b9c107a1d158b245f21a1839a2bec97d05383 3.11

hugovk pushed a commit to hugovk/cpython that referenced this pull request Dec 11, 2023
@AlexWaygood @hugovk
[3.12] pythongh-101100: Improve documentation on function attributes (p… …
bcc84db 
…ythonGH-112933)\n\nCo-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>.\n(cherry picked from commit 4c5b9c1)\n\n\nCo-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
hugovk pushed a commit to hugovk/cpython that referenced this pull request Dec 11, 2023
@AlexWaygood @hugovk
[3.12] pythongh-101100: Improve documentation on function attributes (p… …
f22f581 
…ythonGH-112933)

(cherry picked from commit 4c5b9c1)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>.
@bedevere-app

bedevere-app Bot commented Dec 11, 2023

Copy link
Copy Markdown

GH-112974 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 Dec 11, 2023
@AlexWaygood AlexWaygood deleted the function-attr-docs branch December 11, 2023 16:55
@hugovk

hugovk commented Dec 11, 2023

Copy link
Copy Markdown
Member

@AlexWaygood There's a bit more to do to resolve for 3.11, can I leave this for you?

@AlexWaygood

AlexWaygood commented Dec 11, 2023

Copy link
Copy Markdown
Member Author

Absolutely! (Though probably not tonight 😄)

@AlexWaygood AlexWaygood assigned AlexWaygood and unassigned hugovk Dec 12, 2023
AlexWaygood added a commit that referenced this pull request Dec 12, 2023
@hugovk @AlexWaygood
[3.12] gh-101100: Improve documentation on function attributes (GH-11… …
54fcfbd 
…2933) (#112974)

(cherry picked from commit 4c5b9c1)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
@bedevere-app

bedevere-app Bot commented Dec 12, 2023

Copy link
Copy Markdown

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

@bedevere-app bedevere-app Bot removed the needs backport to 3.11 only security fixes label Dec 12, 2023
AlexWaygood added a commit to AlexWaygood/cpython that referenced this pull request Dec 12, 2023
@AlexWaygood @hugovk
[3.11] pythongh-101100: Improve documentation on function attributes (p… …
a9bfa2f 
…ython#112933)

(cherry-picked from commit 4c5b9c1)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
hugovk added a commit that referenced this pull request Dec 12, 2023
@AlexWaygood @hugovk
[3.11] gh-101100: Improve documentation on function attributes (#112933… …
f83087c 
…) (#113003)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
@AlexWaygood AlexWaygood mentioned this pull request Dec 31, 2023
Open
@AlexWaygood AlexWaygood mentioned this pull request Jan 19, 2024
Closed
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
@AlexWaygood @hugovk @aisk
pythongh-101100: Improve documentation on function attributes (python… …
f236288 
…#112933)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
@AlexWaygood @hugovk @Glyphack
pythongh-101100: Improve documentation on function attributes (python… …
e527059 
…#112933)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
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

Assignees

@AlexWaygood AlexWaygood

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.

2 participants

@AlexWaygood @hugovk