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-110631: Fix reST indentation #110724

Merged
merged 2 commits into from
Oct 11, 2023
Merged

Conversation

ezio-melotti
Copy link
Member

@ezio-melotti ezio-melotti commented Oct 11, 2023

This PR fixes indentation errors that resulted in spurious blockquotes and definition lists in the remaining Doc dirs, plus a few more errors that I missed on the first pass.


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

Comment on lines -1198 to +1208
.. versionchanged::
3.6
.. versionchanged:: 3.6

Add ``._pth`` file support and removes ``applocal`` option from
``pyvenv.cfg``.

.. versionchanged:: 3.6

* Adds ``._pth`` file support and removes ``applocal`` option from
``pyvenv.cfg``.
* Adds :file:`python{XX}.zip` as a potential landmark when directly adjacent
to the executable.
Add :file:`python{XX}.zip` as a potential landmark when directly adjacent
to the executable.

.. deprecated::
3.6
.. deprecated:: 3.6
Copy link
Member Author

Choose a reason for hiding this comment

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

The way this rendered was a bit inconsistent, since the versionchanged had an indented list and the deprecation had inline text. By adding two separate versionchanged, we get rid of the list and the result looks more consistent (3 separate notes with inline text).

@ezio-melotti ezio-melotti merged commit 718391f into python:main Oct 11, 2023
25 checks passed
@miss-islington
Copy link
Contributor

Thanks @ezio-melotti for the PR 🌮🎉.. I'm working now to backport this PR to: 3.11, 3.12.
🐍🍒⛏🤖

@miss-islington
Copy link
Contributor

Sorry, @ezio-melotti, I could not cleanly backport this to 3.12 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 718391f475f2550d99dd794069ca76312f7f6aa6 3.12

@miss-islington
Copy link
Contributor

Sorry, @ezio-melotti, I could not cleanly backport this to 3.11 due to a conflict.
Please backport using cherry_picker on command line.

cherry_picker 718391f475f2550d99dd794069ca76312f7f6aa6 3.11

ezio-melotti added a commit to ezio-melotti/cpython that referenced this pull request Oct 11, 2023
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f)

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

bedevere-app bot commented Oct 11, 2023

GH-110738 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 Oct 11, 2023
ezio-melotti added a commit to ezio-melotti/cpython that referenced this pull request Oct 11, 2023
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f)

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

bedevere-app bot commented Oct 11, 2023

GH-110739 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 Oct 11, 2023
@ezio-melotti ezio-melotti deleted the fix-ind-others branch October 11, 2023 21:12
ezio-melotti added a commit that referenced this pull request Oct 11, 2023
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f)
ezio-melotti added a commit that referenced this pull request Oct 11, 2023
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation..
(cherry picked from commit 718391f)
Glyphack pushed a commit to Glyphack/cpython that referenced this pull request Sep 2, 2024
* Fix wrong indentation in the other dirs.

* Fix more wrong indentation.
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.

4 participants