Skip to content

Improve example docstrings for integration into applications #118

@AbbyGi

Description

@AbbyGi

Expected Behavior

It may be helpful to add a more explicit explanation of how to integrate the examples into real applications in the example docstrings. We should explain that the examples are good for trying out a concept, but for specific use cases, users should start by copying the example code into a new python file and modifying it for the use case there.

Current Behavior

Right now, the example docstrings only explain how to run the examples, and it's not clear how to start integrating the examples into more specified applications. Improved docstrings may help users better understand how to get started modifying the code to work for their needs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    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