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

Example suggestions #7

Closed
kjappelbaum opened this issue Nov 7, 2019 · 2 comments
Closed

Example suggestions #7

kjappelbaum opened this issue Nov 7, 2019 · 2 comments

Comments

@kjappelbaum
Copy link

Here's one more issue for the JOSS review.

You have an example and it seems to work (besides the path issue). To make it even better you can consider having some more comments on it (e.g., a section in the docs that also shows the output plots one should find in the end) or even a Jupyter notebook with plots and markdown fields that describe what happens (and which can run on binder) to show people what the code can do without them having to install the package.

@mgdotdev
Copy link
Owner

mgdotdev commented Nov 8, 2019

I added some comments and references to the DocSite, as well as changed the data source to grab data from the GitHub repository directly so we don't need to worry about path issues. I'm currently looking into hosting jupyter notebooks and binder but atm I think the site and example files should be sufficient.

@kjappelbaum
Copy link
Author

Nice improvement! I do not think that Jupyter/Binder are requirements, but they would be nice if you want the library to be widely used.

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

2 participants