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

Small error in documentation #1453

Closed
paapu88 opened this issue Nov 25, 2020 · 2 comments · Fixed by #1473
Closed

Small error in documentation #1453

paapu88 opened this issue Nov 25, 2020 · 2 comments · Fixed by #1473

Comments

@paapu88
Copy link

paapu88 commented Nov 25, 2020

Dear Developers,

In documentation at
https://satpy.readthedocs.io/en/stable/api/satpy.readers.html#satpy.readers.ahi_hsd.AHIHSDFileHandler
there are some '::' in dictionaries instead of ':'

For instance there is now

scene = satpy.Scene(filenames,
                    reader='ahi_hsd',
                    reader_kwargs={'mask_space':: False})

that is after 'masked_space' there is errorneous '::'
Same thing at couple of other places for the 'ahi_hsd' reader documentation.

Terveisin, Markus

@djhoese
Copy link
Member

djhoese commented Nov 25, 2020

I think this is something @simonrp84 accidentally added in a couple docstrings. I thought he fixed these in other places, but maybe he missed a few. Any memory of this @simonrp84? @paapu88 Would you mind making a pull request to fix this?

Edit: There might be other readers that have this issue. Might be worth searching through all docstrings in the satpy/readers subpackage.

@simonrp84
Copy link
Member

No, this wasn't me @djhoese. The reason I included :: in some other files was because I copied the example of ahi_hsd as I thought this was the right way to do it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants