You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
The text was updated successfully, but these errors were encountered: