Skip to content

gh-133046: Reformat the ast module docstring #133050

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 4 commits into from
Apr 27, 2025

Conversation

hunterhogan
Copy link
Contributor

@hunterhogan hunterhogan commented Apr 27, 2025

See also microsoft/vscode#247525 "Python module docstring renders improperly".

Changes

  1. Removed header with ~~~.
  2. Dedented remaining text.
  3. Reformatted the dedented text from an effective 76-character-width to an 80-character width.

No other changes.

For completeness, the changes would be rendered as
Screenshot 2025-04-27 114014

@bedevere-app

This comment was marked as resolved.

@picnixz picnixz requested a review from AA-Turner April 27, 2025 18:36
@picnixz picnixz changed the title gh-133046: Ast docstring reformat: remove header, dedent, 80-char width. gh-133046: cleanup ast module docstring Apr 27, 2025
@AA-Turner AA-Turner changed the title gh-133046: cleanup ast module docstring gh-133046: Reformat the ast module docstring Apr 27, 2025
@gpshead gpshead added the needs backport to 3.13 bugs and security fixes label Apr 27, 2025
@gpshead gpshead merged commit 6d53b75 into python:main Apr 27, 2025
40 checks passed
@miss-islington-app
Copy link

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

miss-islington pushed a commit to miss-islington/cpython that referenced this pull request Apr 27, 2025
* Fix formatting in module docstring for `ast` python#133046
* pythonGH-133046 ast docstring: remove header, dedent, 80-char width.
* Keep existing wrapping

---------
(cherry picked from commit 6d53b75)

Co-authored-by: Hunter Hogan <hunterhogan@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
@bedevere-app
Copy link

bedevere-app bot commented Apr 27, 2025

GH-133060 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 Apr 27, 2025
gpshead pushed a commit that referenced this pull request Apr 27, 2025
…H-133060)

gh-133046: Reformat the ``ast`` module docstring (GH-133050)

* Fix formatting in module docstring for `ast` #133046
* GH-133046 ast docstring: remove header, dedent, 80-char width.
* Keep existing wrapping

---------
(cherry picked from commit 6d53b75)

Co-authored-by: Hunter Hogan <hunterhogan@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
@hunterhogan hunterhogan deleted the ast_docstring_reformat branch April 27, 2025 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants