py:attribute

Anonymous avatarAnonymous created an issue

Hello, I want to document class variables via autodoc. For this task I use ":attribute name: some text" syntax, but the rendering is not really nice.

It renders as:

 <purple box start>Attribute name:<purple box end>Some text

and not like function parameters as:

 <purple box start>Parameters:<purple box end>name - Some text
    next_one - Some more text

The problem with the current rendering is that with longer attribute names the box takes the whole width. And that a group of attribute descriptions look ugly, so I would be happy if the rendering could be changed like for parameters.

Regards

Comments (0)

  1. Log in to comment
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.