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

DOC: comments to examples #91

Open
martinfleis opened this issue Nov 17, 2019 · 0 comments
Open

DOC: comments to examples #91

martinfleis opened this issue Nov 17, 2019 · 0 comments
Labels
JOSS paper priority: high needs to be resolved soon
Milestone

Comments

@martinfleis
Copy link
Member

Hi,
few comments to examples as a part of openjournals/joss-reviews#1882.

All of them are nice and detailed, covering a lot of options splot offers, so I have just a couple minor remarks. None of them are critical for the review, but they might help.

  1. It is unclear where to find them. There are three examples on the homepage of docs, but 5 in the notebooks folder of the repo. Nowhere in the docs is the link to the rest. Documentation nor readme do not indicate that there are any other resources to check.

  2. Space-time visualisations (giddy) is missing a description. There are just a minor comments in the code. It would be good to explain what is going on, why and how to interpret resulting plots.

  3. In mapping_vba, I assume you wanted to do from splot.mapping import shift_colormap instead if from splot._viz_utils import shift_colormap as _viz_utils is private.

  4. There are some typos here and there across notebooks.

@jGaboardi jGaboardi added JOSS paper priority: high needs to be resolved soon labels Nov 17, 2019
@jGaboardi jGaboardi added this to the JOSS paper milestone Nov 17, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
JOSS paper priority: high needs to be resolved soon
Projects
None yet
Development

No branches or pull requests

2 participants