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

documentation bugs #153

Closed
aburrell opened this issue Feb 8, 2019 · 11 comments
Closed

documentation bugs #153

aburrell opened this issue Feb 8, 2019 · 11 comments

Comments

@aburrell
Copy link
Member

aburrell commented Feb 8, 2019

There are examples in the docs that are wrong:
https://pysat.readthedocs.io/en/latest/examples.html?highlight=restrictMLAT

# perform seasonal average
ivm.bounds(startDate, stopDate)

and it should be

# perform seasonal average
ivm.bounds = (startDate, stopDate)
@jklenzing jklenzing self-assigned this Feb 22, 2019
@jklenzing
Copy link
Member

Going to go through the example code and make sure it all does what it's supposed to.

@jklenzing
Copy link
Member

While I'm at it, I could update the sample documentation images with the uniform sequential colormaps. Thoughts @rstoneback?

@rstoneback
Copy link
Collaborator

rstoneback commented Feb 22, 2019 via email

@jklenzing
Copy link
Member

Largely thinking of improving accessibility, plus matching what a new user would see now that matplotlib has swapped the default colormap.

@rstoneback
Copy link
Collaborator

rstoneback commented Feb 22, 2019 via email

@jklenzing
Copy link
Member

The last two examples don't include the start and stop dates. Any suggestions?

@jklenzing
Copy link
Member

I've updated the first two graphs in the documentation branch. There is not enough information in the second two blocks of code to generate these graphs. In particular, the multiple functions to add are not found. It works as an example of what could be done, but as a new user, I would find this frustrating.

@jklenzing
Copy link
Member

Aha! Found the demo files. Ideally, we should link these so that when one is updated, the other one is too.

@rstoneback
Copy link
Collaborator

rstoneback commented Feb 22, 2019 via email

@jklenzing
Copy link
Member

OK, while I'm in here, I'm going to play with style a little. Probably will be some adjustments. Check out the first example in the documentation branch here:
https://github.com/rstoneback/pysat/blob/documentation/docs/examples.rst

@jklenzing jklenzing added this to In progress in Documentation Update Feb 22, 2019
@jklenzing jklenzing moved this from In progress to Needs review in Documentation Update Feb 24, 2019
@jklenzing
Copy link
Member

Closed with merge of #175.

Documentation Update automation moved this from Needs review to Done Mar 2, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

No branches or pull requests

3 participants