Skip to content

Rework model docstrings for progressive disclosure of complexity #867

@mattdangerw

Description

@mattdangerw

We need to simplify our model docstring so they are more easily understandable, and we can start by porting the changes in #843 to all other models.

Let's do this one model at a time, to keep things granular.

Checklist:

  • Make sure to update any "custom vocabulary" examples to match the model actual vocabulary type and special token requirements (varies per model).
  • Test out all docstring snippets!
  • Make sure to follow our code style guidelines re indentation etc.

Metadata

Metadata

Assignees

No one assigned

    Labels

    stat:contributions welcomeAdd this label to feature request issues so they are separated out from bug reporting issues

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions