-
-
Notifications
You must be signed in to change notification settings - Fork 155
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Returns and Raises switched on Google docstring template #244
Comments
I think these changes to the .mustache fix the issue.
|
Yes, I see the same thing. Using your template worked for me. One other thing is the style guide says a period after the summaryPlaceholder on line one. These are my first 2 lines:
It looks like there are some other things missing from the Google style. Section 3.8 describes what to do for google python docstrings, and in 3.8.4 it says when documenting a class to use the 'Attributes:' marker for public attributes of the class. From a quick check of the template_data.ts, I did not see that attributes are being looked for. Also, if it were to be added I see it doesn't detect the arguments/attributes currently for dataclasses or Pydantic. Here is the google template without typing:
|
According to the style guide, Returns should be outlined prior to Raises in google style docstring, yet when I generate one that has both, the Raises appear before the returns
https://google.github.io/styleguide/pyguide.html
The same can be seen in this example .mustache in the repo
https://github.com/NilsJPWerner/autoDocstring/blob/HEAD/src/docstring/templates/google.mustache
Thanks for a great extension!
The text was updated successfully, but these errors were encountered: