-
-
Notifications
You must be signed in to change notification settings - Fork 32.9k
gh-133046: Fix heading in ast
module docstring
#133047
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
Conversation
Most changes to Python require a NEWS entry. Add one using the blurb_it web app or the blurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
ast
https://github.com/python/cpython/issues/133046ast
https://github.com/python/cpython/issues/133046 gh-133046 133046
ast
https://github.com/python/cpython/issues/133046 gh-133046 133046ast
ast
ast
module docstring
ast
module docstringast
module docstring
Quick question but are there other modules with that issue? |
ast
module docstringast
module docstring
I only found |
This is an easy enough fix, but feels like a bug in VS Code. Have you reported it to VS Code? There could be other projects also using tildes as underlines, as the tilde is a valid and recommended underline character for sections in reStructuredText:
https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#sections |
I think it's interpreting it as markdown, not RST. |
Closing as churn, this should be fixed in VS Code. A |
Let's change it in another PR if @AA-Turner wants to. |
gh-133046: Fix ast module docstring markup for better rendering in VS Code
This PR updates the
ast
module docstring to use---
instead of~~~
for section headers. This change improves the docstring rendering in Visual Studio Code and similar tools, as discussed in issue #133046.See: #133046