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
{{ message }}
This repository has been archived by the owner on Dec 16, 2022. It is now read-only.
defsome_function(arg1: int, *, kwarg1: str) ->None:
"""Do something with the args. Args: arg1: first pos or kw argument. Keyword Args: kwarg1: first kw only argument. Returns: Nothing. """
...
darglint will raise a DAR101 Missing parameter(s) in Docstring: - kwarg1
Note that the section can be named Keyword Args or Keyword Arguments, see napoleon docs
The text was updated successfully, but these errors were encountered:
It's not a section according to the Google styleguide. I don't think darglint's goal is to support any convention introduced by any third-party library.
Sure, it could be supported. But would it be mandatory? Under what circumstances? What about positional arguments? What configuration options? I'm not working on darglint actively, but if you want to write a well-reasoned plan for including this feature, update all of the code/tests/documentation, feel free. We could create a separate branch, and merge to the main branch once everything is copacetic.
The main idea could be that the Keyword Args section would be optional at first (not an error when present, not required to be present), and could be done mandatory in a future major version, unless we want strong adherence to the style guide, in which case it would remain optional.
Consider the following function:
darglint
will raise aDAR101 Missing parameter(s) in Docstring: - kwarg1
Note that the section can be named
Keyword Args
orKeyword Arguments
, see napoleon docsThe text was updated successfully, but these errors were encountered: