Skip to content

docs: move general class docstrings from __init__ to class level for better API refs #1534

@janfb

Description

@janfb

On the new docs website we now have nice API references, however, the docstrings with a high-level description of a class do not show up because there are placed in __init__ and not at the class level:

Image

code:

Image

Goal for fixing this issue:

  • go over all the inference classes (NPE_X, NLE_X, etc) and move the high-level description from the __init__ to the class level. Keep in __init__ only a brief docstring and the Args.
  • fix formatting issues in the docstrings along the way, e.g., some docstring contain html stuff like <br/>, which should be remove (or does this have any purpose @michaeldeistler ?)

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsImprovements or additions to documentationgood first issueGood for newcomers

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions