Skip to content
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

gh-101100: Improve documentation on function attributes #112933

Merged
merged 4 commits into from
Dec 11, 2023

Conversation

AlexWaygood
Copy link
Member

@AlexWaygood AlexWaygood commented Dec 10, 2023

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/

@AlexWaygood AlexWaygood marked this pull request as ready for review December 10, 2023 14:35
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.

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

Doc/reference/datamodel.rst Outdated Show resolved Hide resolved
@hugovk
Copy link
Member

hugovk commented Dec 11, 2023

And backport?

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 bug and security fixes labels Dec 11, 2023
@hugovk hugovk merged commit 4c5b9c1 into python:main Dec 11, 2023
25 checks passed
@miss-islington-app
Copy link

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
Copy link

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
Copy link

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
…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
…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
Copy link

bedevere-app bot commented Dec 11, 2023

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 bug and security fixes label Dec 11, 2023
@AlexWaygood AlexWaygood deleted the function-attr-docs branch December 11, 2023 16:55
@hugovk
Copy link
Member

hugovk commented Dec 11, 2023

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

@AlexWaygood
Copy link
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
…2933) (#112974)

(cherry picked from commit 4c5b9c1)

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

bedevere-app bot commented Dec 12, 2023

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
…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
…) (#113003)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
aisk pushed a commit to aisk/cpython that referenced this pull request Feb 11, 2024
…#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
…#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
Labels
docs Documentation in the Doc dir skip news
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants