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.

Class Level docstrings should be placed underneath class definition #31

@raphant

Description

@raphant

Environment

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

Issue

When docstring are generated for classes, they are added as a comment above the class definition:

# The Opts class is a class that contains all the options that the user can set for the program.
class Opts:
    audio_only = False

This will not satisfy the Missing or empty docstring inspection in PyCharm and the comment will not appear in the Quick Documentation dialog.

Expectation

class Opts:
   """
   The Opts class is a class that contains all the options that the user can set for the program.
   """

   audio_only = False

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