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

Class Level docstrings should be placed underneath class definition #31

Open
raphant opened this issue Mar 3, 2022 · 0 comments
Open

Comments

@raphant
Copy link

raphant commented Mar 3, 2022

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
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant