# Revisiting attribute docstrings

**URL:** <https://discuss.python.org/t/revisiting-attribute-docstrings/36413>\
**Category:** Ideas\
**Tags:** documentation\
**Created:** [October 17, 2023, 2:50am UTC](https://discuss.python.org/t/revisiting-attribute-docstrings/36413 "2023-10-17T02:50:15Z")\
**Posts on this page:** 1\
**Showing post:** 5

<div class="post-metadata">

**Author:** ![csm10495](https://sea2.discourse-cdn.com/flex002/user_avatar/discuss.python.org/csm10495/32/9731_2.png) [@csm10495](https://discuss.python.org/u/csm10495)\
**Post date:** [October 17, 2023, 5:25am UTC](https://discuss.python.org/t/revisiting-attribute-docstrings/36413/5 "2023-10-17T05:25:26Z")

</div>

I understand but I personally prefer the other way: have the docstring above the definition.

Even if they can be parsed by tooling, I have to look at it, and don’t like the way docstring below variable looks.

I don’t think I’ve ever seen docstring below variable besides class/function declaration.

If we decide to formalize a format, if prefer it be above or on the same line.

Edit:

I think I’ve seen tools parse

```auto
V = 'hello' #: this is the docstring for V

```

As a way of doing one liner

Similarly also for two lines:

```auto
#: this is the docstring for V
V = 'hello'

```

---

_[View the full topic](https://discuss.python.org/t/revisiting-attribute-docstrings/36413)._