"Attributes:" Google-style docstring support for automatic help string

[Conchylicultor]

Currently, simple_parsing force to add comments along the attributes they are defined

It would be nice if it was also supporting the google docstring style Attributes field: https://google.github.io/styleguide/pyguide.html#384-classes

@dataclass
class Args:
  """args.

  Attributes:
    user: Username
    verbose: Display logs
  """
  user: str
  verbose: bool = False

Rational: The simple_parsing conventions are not supported by standard tools like:

• CiderV hover help information:

• Sphinx API doc generator: https://www.sphinx-doc.org/en/master/usage/extensions/napoleon.html

Currently simple parsing force to document each fields twice (as # comment and inside the cls.__doc__).

[lebrice]

Great suggestion @Conchylicultor ! I'll take a look at existing parsing tools for this, would be nicer than having to write it myself.

Does this problem also arise if you use docstrings under the fields?

[brentyi]

@lebrice as an FYI I've had a really good experience with docstring_parser! Could possibly also be used in #156?

[lebrice]

Sure @brentyi , I'll check it out.

However, do you get the same problem when using docstrings under the fields?

[brentyi]

Hm, my understanding with the triple-quoted attribute docstrings is:

• Sphinx would work.
• In Pyright, Attributes wouldn't show up in the Args() docstring, but would if you hovered over user in Args(user="something") or args.user.

I generally prefer this style over the monolithic Attributes: list.

[lebrice]

Should be fixed by #179 . Let me know if you have other issues :)