Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Docs: Fix indentation in slice class of functions.rst #134393

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 3 commits into from
Jun 25, 2025
Merged

Docs: Fix indentation in slice class of functions.rst #134393

merged 3 commits into from
Jun 25, 2025
+5 −5

Conversation

reynoldsnlp
Copy link
Contributor

@reynoldsnlp reynoldsnlp commented May 20, 2025 •
edited by ZeroIntensity
Loading

Paragraph should not be under slice.step. It applies to the whole class.

📚 Documentation preview 📚: https://cpython-previews--134393.org.readthedocs.build/en/134393/library/functions.html#slice

@reynoldsnlp
Update functions.rst
0c83a15 
Paragraph should not be under `slice.step`. It applies to the whole class.
@python-cla-bot
Copy link

python-cla-bot bot commented May 20, 2025 •
edited
Loading

All commit authors signed the Contributor License Agreement.

CLA signed

@bedevere-app bedevere-app bot added docs Documentation in the Doc dir skip news awaiting review labels May 20, 2025
@github-project-automation github-project-automation bot moved this to Todo in Docs PRs May 20, 2025
@ZeroIntensity ZeroIntensity added needs backport to 3.13 bugs and security fixes needs backport to 3.14 bugs and security fixes labels May 20, 2025
@vstinner
Copy link
Member

The change looks wrong.

@ZeroIntensity
Copy link
Member

What's wrong with it? That paragraph renders pretty weirdly on the current documentation.

@vstinner
Copy link
Member

The paragraph describes start, step and stop attributes, so I think that the current doc is correct. No?

@ZeroIntensity
Copy link
Member

Eh, it looks a little funny to me, particularly because it reads as being exclusive to step. I'd prefer we either change it to this, or move that paragraph to before start.

@reynoldsnlp
Copy link
Contributor Author

+1 for moving the paragraph above start/end/step. Should I commit that change?

@ZeroIntensity
Copy link
Member

Sorry for the late response. Go for it.

vstinner
vstinner approved these changes Jun 25, 2025
View reviewed changes
Copy link
Member

@vstinner vstinner left a comment

Choose a reason for hiding this comment

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

LGTM

@ZeroIntensity ZeroIntensity merged commit 6227662 into python:main Jun 25, 2025
29 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in Docs PRs Jun 25, 2025
@miss-islington-app
Copy link

Thanks @reynoldsnlp for the PR, and @ZeroIntensity for merging it 🌮🎉.. I'm working now to backport this PR to: 3.13, 3.14.
🐍🍒⛏🤖

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 25, 2025
@reynoldsnlp @miss-islington
Docs: Fix indentation in slice class of functions.rst (pythonGH-1…
9f26705 
…34393)

Paragraph should not be under `slice.step`. It applies to the whole class.

---------
(cherry picked from commit 6227662)

Co-authored-by: Rob Reynolds <[email protected]>
Co-authored-by: Rob Reynolds <[email protected]>
@bedevere-app
Copy link

bedevere-app bot commented Jun 25, 2025

GH-135948 is a backport of this pull request to the 3.14 branch.

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Jun 25, 2025
@reynoldsnlp @miss-islington
Docs: Fix indentation in slice class of functions.rst (pythonGH-1…
9c4f4d9 
…34393)

Paragraph should not be under `slice.step`. It applies to the whole class.

---------
(cherry picked from commit 6227662)

Co-authored-by: Rob Reynolds <[email protected]>
Co-authored-by: Rob Reynolds <[email protected]>
@bedevere-app bedevere-app bot removed the needs backport to 3.14 bugs and security fixes label Jun 25, 2025
@bedevere-app
Copy link

bedevere-app bot commented Jun 25, 2025

GH-135949 is a backport of this pull request to the 3.13 branch.

@bedevere-app bedevere-app bot removed the needs backport to 3.13 bugs and security fixes label Jun 25, 2025
@ZeroIntensity
Copy link
Member

Congrats on your first contribution @reynoldsnlp :)

ZeroIntensity pushed a commit that referenced this pull request Jun 25, 2025
@miss-islington @reynoldsnlp
[3.13] Docs: Fix indentation in slice class of functions.rst (GH-…
335d7da 
…134393) (GH-135949)

Docs: Fix indentation in `slice` class of `functions.rst` (GH-134393)

Paragraph should not be under `slice.step`. It applies to the whole class.

(cherry picked from commit 6227662)

Co-authored-by: Rob Reynolds <[email protected]>
ZeroIntensity pushed a commit that referenced this pull request Jun 25, 2025
@miss-islington @reynoldsnlp
[3.14] Docs: Fix indentation in slice class of functions.rst (GH-…
39bbf59 
…134393) (#135948)

Docs: Fix indentation in `slice` class of `functions.rst` (GH-134393)

Paragraph should not be under `slice.step`. It applies to the whole class.

(cherry picked from commit 6227662)

Co-authored-by: Rob Reynolds <[email protected]>
@reynoldsnlp reynoldsnlp deleted the patch-1 branch June 26, 2025 21:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vstinner vstinner vstinner approved these changes

@ZeroIntensity ZeroIntensity ZeroIntensity approved these changes

Assignees
No one assigned
Labels
docs Documentation in the Doc dir skip issue skip news
Projects
Docs PRs
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@reynoldsnlp @vstinner @ZeroIntensity