PEP 727: Documentation Metadata in Typing

:-1: Putting doc per-arg: cue the arguments about how to render them, sortation, etc
:+1: Hand-write the docstring. Arguments don’t live in a vacuum (they relate to each other, are sometimes constrained by each other, etc). The function is the relationship between inputs and outputs, so it should be documented as a whole. Docstring is also the only reasonable way to document *args and **kwargs

I probably wouldn’t use this PEP and I’d resent the pressure to use it if it were accepted :upside_down_face:

3 Likes