You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Ive used google style docstrings in PyCharm a lot (w/ sphinx.napoleon) and
this looked to be nicest out of the box equivalent I could find for that w/ VsCode.
When following the google style examples for module level autodoc, it prefers that them to start right at the top before any import statements. "Files should start with a docstring describing the contents and usage of the module"
I got two strange behaviors when using this exension to do that
empty file: erroneously indented
"""_summary
"""
existing file, (after docstringing in a simple no argument function and then going up to the top level). Also erroneously indented 4 space, which has to be tidied.
"""_summary
Versions (please complete the following information):
autoDocstring Version: 0.6.1
Operating System: Windows
Vscode Version: 1.76.1
Original Code (with line to generate on):
"""
Expected Result:
"""A one-line summary of the module or program, terminated by a period.Leave one blank line. The rest of this docstring should contain anoverall description of the module or program. Optionally, it may alsocontain a brief description of exported classes and functions and/or usageexamples.Typical usage example: foo = ClassFoo() bar = foo.FunctionBar()"""
Actual Result:
Debug log:
Set autoDocstring.logLevel to "Debug", recreate the bug, and then copy the debug logs from the autoDocstring output channel.
Stack trace:
If an error was reported by autoDocstring please copy the stack trace from the autoDocstring output channel.
Additional context
Add any other context about the problem here.
The text was updated successfully, but these errors were encountered:
Describe the bug
Ive used google style docstrings in PyCharm a lot (w/ sphinx.napoleon) and
this looked to be nicest out of the box equivalent I could find for that w/ VsCode.
When following the google style examples for module level autodoc, it prefers that them to start right at the top before any import statements. "Files should start with a docstring describing the contents and usage of the module"
I got two strange behaviors when using this exension to do that
empty file: erroneously indented
"""_summary
"""
existing file, (after docstringing in a simple no argument function and then going up to the top level). Also erroneously indented 4 space, which has to be tidied.
"""_summary
Raises:
ValueError: description
ValueError: description
ValueError: description
ValueError: description
Returns:
_type: description
""""
Versions (please complete the following information):
Original Code (with line to generate on):
Expected Result:
Actual Result:
Debug log:
Set
autoDocstring.logLevel
to "Debug", recreate the bug, and then copy the debug logs from theautoDocstring
output channel.Stack trace:
If an error was reported by autoDocstring please copy the stack trace from the
autoDocstring
output channel.Additional context
Add any other context about the problem here.
The text was updated successfully, but these errors were encountered: