FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

gh-101100: Improve documentation on function attributes by AlexWaygood · Pull Request #112933 · python/cpython · GitHub

  1. python
  2. cpython

Repository navigation

gh-101100: Improve documentation on function attributes - #112933

Merged
hugovk merged 4 commits into
python:mainfrom
AlexWaygood:function-attr-docs
Dec 11, 2023
ConversationCommits (4)ChecksFiles changed
Merged

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

Conversation

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

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.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Comment thread Doc/reference/datamodel.rst Outdated

hugovk commented Dec 11, 2023

Copy link
Copy Markdown
Member

And backport?

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

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 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 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
[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
[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 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 Bot removed the needs backport to 3.12 only security fixes label Dec 11, 2023
AlexWaygood deleted the function-attr-docs branch December 11, 2023 16:55

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 commented Dec 11, 2023

Copy link
Copy Markdown
Member Author

Absolutely! (Though probably not tonight 😄)

AlexWaygood assigned AlexWaygood and unassigned hugovk Dec 12, 2023
AlexWaygood added a commit that referenced this pull request Dec 12, 2023
[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 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 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
[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
[3.11] gh-101100: Improve documentation on function attributes (#112933…
f83087c 
…) (#113003)

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

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

hugovk hugovk approved these changes

Assignees

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

Back | FazBrowse Home | New Git URL