Skip to content

Examples in documentation should be broken up by module #443

@pganssle

Description

@pganssle

Currently the documentation has a huge monolithic "examples" page that covers how a bunch of the classes and functions are used. I think it would be much easier to stumble on if these examples were moved into the base page for their respective modules (e.g. the module docstring, for the most part - though maybe we want to duplicate some of the examples in the class/function docstrings).

If this is done, to avoid breaking old links, the "examples" page should be replace with links to the examples anchor on each of the respective module pages.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions