Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve example docstrings for integration into applications #118

Open
AbbyGi opened this issue Mar 16, 2021 · 0 comments
Open

Improve example docstrings for integration into applications #118

AbbyGi opened this issue Mar 16, 2021 · 0 comments

Comments

@AbbyGi
Copy link
Contributor

AbbyGi commented Mar 16, 2021

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant