Skip to content

ast module docstring markup renders poorly in Visual Studio Code #133046

@hunterhogan

Description

@hunterhogan

Documentation

ast module docstring renders as

Image

Due to ~~~

Image

Change to ---

Image

Problems solved

Image

Environment(s)

  • Windows 11
  • Visual Studio Code and Visual Studio Code Insiders
  • For me, it has always rendered that way (which is only about five months of using the ast module)

Module on GitHub

cpython/Lib/ast.py

Lines 1 to 26 in 614d792

"""
ast
~~~
The `ast` module helps Python applications to process trees of the Python
abstract syntax grammar. The abstract syntax itself might change with
each Python release; this module helps to find out programmatically what
the current grammar looks like and allows modifications of it.
An abstract syntax tree can be generated by passing `ast.PyCF_ONLY_AST` as
a flag to the `compile()` builtin function or by using the `parse()`
function from this module. The result will be a tree of objects whose
classes all inherit from `ast.AST`.
A modified abstract syntax tree can be compiled into a Python code object
using the built-in `compile()` function.
Additionally various helper functions are provided that make working with
the trees simpler. The main intention of the helper functions and this
module in general is to provide an easy to use interface for libraries
that work tightly with the python syntax (template engines for example).
:copyright: Copyright 2008 by Armin Ronacher.
:license: Python License.
"""

Linked PRs

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirstdlibStandard Library Python modules in the Lib/ directory

    Projects

    Status

    Todo

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions