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

Enhance examples usability #1172

Open
markbader opened this issue Aug 20, 2024 · 0 comments
Open

Enhance examples usability #1172

markbader opened this issue Aug 20, 2024 · 0 comments

Comments

@markbader
Copy link
Contributor

Detailed Description

  • Affected library: webknossos

We should have another look over the examples of the webknossos repository. Currently, the assumption is that they are read over the rendered documentation. Therefore, the docstring within the example files is rather short. Users that explore the GitHub Repo might need further explanations within the example python files.

Not all examples can be executed. Examples like announce dataset uploads are partly only described in comments and might be difficult to actually apply for users.

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

No branches or pull requests

1 participant