# PEP 727: Documentation Metadata in Typing

**URL:** <https://discuss.python.org/t/pep-727-documentation-metadata-in-typing/32566>\
**Category:** PEPs\
**Tags:** typing\
**Created:** [August 29, 2023, 10:17pm UTC](https://discuss.python.org/t/pep-727-documentation-metadata-in-typing/32566 "2023-08-29T22:17:39Z")\
**Posts on this page:** 1\
**Showing post:** 171

<div class="post-metadata">

**Author:** ![abatea](https://sea2.discourse-cdn.com/flex002/user_avatar/discuss.python.org/abatea/32/16368_2.png) [@abatea](https://discuss.python.org/u/abatea)\
**Post date:** [December 13, 2023, 1:12pm UTC](https://discuss.python.org/t/pep-727-documentation-metadata-in-typing/32566/171 "2023-12-13T13:12:24Z")

</div>

👎 Putting doc per-arg: cue the arguments about how to render them, sortation, etc  
👍 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 🙃

---

_[View the full topic](https://discuss.python.org/t/pep-727-documentation-metadata-in-typing/32566)._