Skip to content

Add doctests #25

Description

@abhinav-upadhyay

doctests are example code snippets in the doc string of the APIs and they can be tested like regular unit tests. Having doctests makes sure that our documentation is in sync with the API changes. We could add examples from the README in the doc strings to start with.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions