Trailing underscores in parameter names are dropped

Anonymous avatarAnonymous created an issue

When documenting Python parameters with trailing underscores:

def example(str_):
    """Notice that the parameter `str_` has a trailing underscore.

    :param str_: Unfortunately, it gets dropped in the resulting HTML.
    """

The resulting HTML documentation completely omits the trailing underscore.

Comments (5)

  1. Daniel Neuhäuser

    I think I know what causes this issue. Docutils interprets the trailing underscore in str_ as markup for a link named str, therefore it drops the underscore. If it is escaped it works.

    def example(str_):
        """Notice that the parameter `str_` has a trailing underscore.
    
        :param str\_: Unfortunately, it gets dropped in the resulting HTML if it's not escaped.
        """
    

    I'm not sure how to fix this or if it can be fixed at all in Sphinx.

  2. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.