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

Comments placed in the wrong location. #24

@raphant

Description

@raphant

Environment

AI Doc Writer Version: 1.0.10
PyCharm Version: 2021.3.2
OS: Manjaro 5.16.7

Issue

When generating docs for a property function formatted like the code below, the docstring is added to the wrong location.

Before generation

    @property
    def indicators(
        self,
    ) -> dict[str, Union[ind.Indicator, ind.OverlayIndicator, ind.IndexIndicator]]:
        return self._active_indicators

After generation

    @property
    def indicators(
	    """
	    Returns a dictionary of all the active indicators
	    :return: A dictionary of indicator objects.
	    """
        self,
    ) -> dict[str, Union[ind.Indicator, ind.OverlayIndicator, ind.IndexIndicator]]:
        return self._active_indicators

Expected

    @property
    def indicators(
        self,
    ) -> dict[str, Union[ind.Indicator, ind.OverlayIndicator, ind.IndexIndicator]]:
        """
        Returns a dictionary of all the active indicators
        :return: A dictionary of indicator objects.
        """
        return self._active_indicators

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