autodoc: a more compact way to document static members

Anonymous avatarAnonymous created an issue

A fairly coding style is to put comments on the same line as variable/attribute definition:

class Bits:
    SOFT_RESET = 0x01 #: comment for SOFT
    HARD_RESET = 0x02 #: comment for HARD

The major advantage of this style is its compactness.

I think it would be very useful to support this style in autodoc? (Currently autodoc wants special comments to be put on a separate line, which essentially doubles the size of the code)

Comments (4)

  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
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.