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
Describe the bug
The docstring indicates that a function yields or returns whenever there is a variable/command in the function that ends with the word "yield" or "return", even if this is just a variable e.g. named strength_yield or preturn.
Versions (please complete the following information):
autoDocstring Version:0.6.1
Operating System: Windows Server 2016 version 1607
Vscode Version: 1.87.0
Original Code (with line to generate on):
defno_yield_func(a, b):
# generate on this lineresult=a*bstrength_yield=5returnresult
Expected Result:
"""_summary_ Parameters ---------- a : _type_ _description_ b : _type_ _description_ Returns ------- _type_ _description_ """
Actual Result:
"""_summary_ Parameters ---------- a : _type_ _description_ b : _type_ _description_ Returns ------- _type_ _description_ Yields ------ _type_ _description_ """
Debug log:
Set autoDocstring.logLevel to "Debug", recreate the bug, and then copy the debug logs from the autoDocstring output channel.
Describe the bug
The docstring indicates that a function yields or returns whenever there is a variable/command in the function that ends with the word "yield" or "return", even if this is just a variable e.g. named
strength_yield
orpreturn
.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
I'm not entirely sure, but I think this can be resolved by changing the regex in the
parseFromBody
call in theparseYields
functionThe text was updated successfully, but these errors were encountered: