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

Make use of a dedicated example file in "getting-started" section in docs #12

Closed
sappelhoff opened this issue Sep 5, 2020 · 2 comments
Labels
JOSS review https://github.com/openjournals/joss-reviews/issues/2621

Comments

@sappelhoff
Copy link
Contributor

related to JOSS review (openjournals/joss-reviews#2621)

I was just trying to follow the getting started section in the docs, and noticed that the "examplary workflow on a single file" stays relatively abstract.

I think it'd be great to add a dedicated example file to the repository and make use of that file in that section of the docs: Instead of describing the functions as currently done, describe single steps and expect users to follow along.

For that to work, example files should ideally be shipped with the installation and/or the docs should explain how to easily get these files.

There should also be a practical example of reading a file in "custom" format, like here but with a real file that users can open and look at.

@JanCBrammer
Copy link
Owner

@sappelhoff, see 2b3705e.

@sappelhoff
Copy link
Contributor Author

Cool, I just tried it out and I am very happy with the improvements, great job @JanCBrammer!

@JanCBrammer JanCBrammer added the JOSS review https://github.com/openjournals/joss-reviews/issues/2621 label Sep 29, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
JOSS review https://github.com/openjournals/joss-reviews/issues/2621
Projects
None yet
Development

No branches or pull requests

2 participants