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
The current template for google docstring's Returns section is as follows:
Returns:
_type_: _description_
The Google Python Style Guide suggests a sentence like A dict mapping keys to the corresponding table row data fetched. instead of these type os structures.
Worse still, in case the return value is a tuple, the current template suggests _type_: _description_ blocks should be added to describe each value, in the same way numpy style does. But the numpy pattern is explicitly forbidden by the style guide.
The template should be more google-esque or, at least, less numpy-esque.
Versions (please complete the following information):
Describe the bug
The current template for google docstring's
Returns
section is as follows:The Google Python Style Guide suggests a sentence like
A dict mapping keys to the corresponding table row data fetched.
instead of these type os structures.Worse still, in case the return value is a tuple, the current template suggests
_type_: _description_
blocks should be added to describe each value, in the same way numpy style does. But the numpy pattern is explicitly forbidden by the style guide.The template should be more google-esque or, at least, less numpy-esque.
Versions (please complete the following information):
Original Code (with line to generate on):
Expected Result:
or
Actual Result:
The text was updated successfully, but these errors were encountered: