Pick attributes without docstrings

[pawamoy]

Just like we still select objects with no docstrings, we could also pick attributes without docstrings.

The user can then configure the plugin to render them or not.

[cs01]

Would an example of this be if a type annotation is present for the return type but there is no docstring for it (Returns: ...), the generated mkdocs would still have a Returns section?

[pawamoy]

No, I was talking about picking module variables, class variables and instance variables (in init methods) that have no docstrings, to be consistent with the selection method for other objects (we currently select methods/classes that have no docstrings as well, and rendering them or not based on configuration).

But what you wrote would indeed be an interesting feature. Sometimes the method/function name is self-explanatory about what it returns, so printing its return type without having to add Returns: would be nice.

[ofek]

We very much need this 😄

[ofek]

Any update?

[pawamoy]

Sorry, nope, I've been working on other things. I'll try to work on this these next few days.

[ofek]

Has this been implemented?

[pawamoy]

Still not @ofek 😅 But I'm currently working on refactoring the attribute parser, which will make it easier to implement this feature ☺️

So, it's on the way!