Skip to content

gh-107432 Fix incorrect indentation in annotations HOWTO #107445

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

Merged
merged 1 commit into from
Aug 5, 2023

Conversation

evildmp
Copy link
Contributor

@evildmp evildmp commented Jul 29, 2023

Body text in https://docs.python.org/3/howto/annotations.html was indented throughout, and was being rendered in blockquote elements.


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

Body text in https://docs.python.org/3/howto/annotations.html was
indented throughout, and was being rendered in blockquote elements.
Copy link
Member

@AlexWaygood AlexWaygood left a comment

Choose a reason for hiding this comment

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

Thanks! This looks good, and I think we should merge it. However, it's pretty unfortunate for git blame that this touches nearly every line in the file.

I wonder if we should add a .git-blame-ignore-revs file to CPython. After this is merged, perhaps we could add the commit to that file, so that digging through git blame is easier for future contributors. Curious if others have any thoughts on this.

@pradyunsg
Copy link
Member

Curious if others have any thoughts on this.

I think it's a good idea. This change is an improvement and, given that we have a mechanism to avoid the issues this could cause to git blame (which, IIUC, is the main issue this would cause), we should utilize that mechanism.

@AlexWaygood AlexWaygood changed the title gh-107432 Fix incorrect indentation in annotations document gh-107432 Fix incorrect indentation in annotations HOWTO Aug 2, 2023
@AlexWaygood
Copy link
Member

I've asked on the Core Dev discord if there are any objections to adding a .git-blame-ignore-revs file.

@hugovk
Copy link
Member

hugovk commented Aug 5, 2023

I've asked on the Core Dev discord if there are any objections to adding a .git-blame-ignore-revs file.

There was support and no objections, and it should be mentioned in the devguide.

@hugovk hugovk added needs backport to 3.11 only security fixes needs backport to 3.12 only security fixes labels Aug 5, 2023
@hugovk hugovk merged commit 5e2746d into python:main Aug 5, 2023
@miss-islington
Copy link
Contributor

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

@bedevere-bot
Copy link

GH-107654 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 Aug 5, 2023
@bedevere-bot
Copy link

GH-107655 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 Aug 5, 2023
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 5, 2023
…nGH-107445)

pythongh-107432 Fix incorrect indentation in annotations document

Body text in https://docs.python.org/3/howto/annotations.html was
indented throughout, and was being rendered in blockquote elements.
(cherry picked from commit 5e2746d)

Co-authored-by: Daniele Procida <[email protected]>
miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Aug 5, 2023
…nGH-107445)

pythongh-107432 Fix incorrect indentation in annotations document

Body text in https://docs.python.org/3/howto/annotations.html was
indented throughout, and was being rendered in blockquote elements.
(cherry picked from commit 5e2746d)

Co-authored-by: Daniele Procida <[email protected]>
hugovk pushed a commit that referenced this pull request Aug 5, 2023
…07445) (#107655)

gh-107432 Fix incorrect indentation in annotations HOWTO (GH-107445)

gh-107432 Fix incorrect indentation in annotations document

Body text in https://docs.python.org/3/howto/annotations.html was
indented throughout, and was being rendered in blockquote elements.
(cherry picked from commit 5e2746d)

Co-authored-by: Daniele Procida <[email protected]>
Yhg1s pushed a commit that referenced this pull request Aug 5, 2023
…07445) (#107654)

gh-107432 Fix incorrect indentation in annotations HOWTO (GH-107445)

gh-107432 Fix incorrect indentation in annotations document

Body text in https://docs.python.org/3/howto/annotations.html was
indented throughout, and was being rendered in blockquote elements.
(cherry picked from commit 5e2746d)

Co-authored-by: Daniele Procida <[email protected]>
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.

6 participants