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

Examples in the documentation should be elaborated more #28

Open
JaeyeongYang opened this issue Dec 9, 2020 · 0 comments
Open

Examples in the documentation should be elaborated more #28

JaeyeongYang opened this issue Dec 9, 2020 · 0 comments
Labels
documentation This issue is regarding the documentation help wanted Extra attention is needed

Comments

@JaeyeongYang
Copy link
Member

As ADOpy includes several implementations for specific tasks and models, it would be great to include detailed examples for these implementations. However, the current examples somewhat lack descriptions in plain English.

The example files should be included in /docs/source/examples as Jupyter notebook files. If the notebook file is properly executed, it can be automatically integrated into the Sphinx-based documentation (based on nbsphinx).

@JaeyeongYang JaeyeongYang added help wanted Extra attention is needed documentation This issue is regarding the documentation labels Dec 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation This issue is regarding the documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant