Skip to content
This repository was archived by the owner on Dec 15, 2022. It is now read-only.
This repository was archived by the owner on Dec 15, 2022. It is now read-only.

Highlight docstrings as reStructuredText #151

@remcohaszing

Description

@remcohaszing

Since I noticed this plugin tries to detect SQL from strings in order to highlight them, I figured it might just as well highlight docstrings as reStructuredText. Also there is no need to detect if any docstrings could be highlighted as SQL.

This would affect:

  • function docstrings
  • class docstrings
  • module docstrings
  • sphinx property comments
"""
Module docstring.

"""
class A:
    """
    Class docstring

    """
    #: Property comment
    prop = 'prop'

    def __init__(self):
        """
        Function docstring

        """
        #: Property comment
        self.prop = 'prop'


def a():
    """
    Function docstring

    """


#: Property comment
prop = 'prop'

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions