Skip to content

Improve Python API Documentation #58

@gwenchee

Description

@gwenchee

This issue can be closed when the following suggestion is implemented:

I'd recommend adding formatting to variable, function, and class names in the docstrings for your classes and functions so they render with styling and can be easily differentiated from normal text on the web-hosted API docs. This is a lot of work though so may be better suited for a new PR.

Originally posted by @yardasol in #53 (review)

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions