Consider allowing ivar and cvar (and vartype) for attributes in sphinx style

[tmke8]

These are little-known fields, but they are documented here: https://www.sphinx-doc.org/en/master/usage/domains/python.html#info-field-lists

ivar is for instance attributes and cvar is for class attributes, so:

from typing import ClassVar

class A:
  """My class

  :ivar n: Number of items.
  :cvar threshold: Threshold for items.
  """

  n: int
  threshold: ClassVar[int] = 3
  
  def __init__(self) -> None:
    self.n = 2

If you wanted to specify a type you could do it with vartype.

The main advantage over the .. attribute:: syntax is that it's more compact, which is why I prefer it.

[jsh9]

Thanks for sharing this! I didn't know about this until seeing your post.

I'd like to support this, but it requires non trivial code changes:

• Firstly, I need to update the docstring parser (https://github.com/jsh9/docstring_parser_fork) to recognize ivar and cvar (it currently does not)
• Secondly, use the new version of the docstring parser in pydoclint

The first part is more time consuming. I can get to it in the next few weeks (or longer, depending on my availability). But if you'd like to take a stab at it, I'd really appreciate it! (I opened an issue there: jsh9/docstring_parser_fork#9)