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

Add documentation about y and x dimensions for custom readers #1032

Merged
merged 2 commits into from Jan 10, 2020

Conversation

djhoese
Copy link
Member

@djhoese djhoese commented Jan 6, 2020

After fixing parts of the tropomi_l2 reader in #1031 I noticed that the custom reader documentation doesn't explicitly mention that dimensions should be named y and x. This PR adds that information.

  • Fully documented

@coveralls
Copy link

coveralls commented Jan 7, 2020

Coverage Status

Coverage increased (+0.02%) to 87.29% when pulling c522656 on djhoese:doc-custom-reader-dims into c80a510 on pytroll:master.

@codecov
Copy link

codecov bot commented Jan 7, 2020

Codecov Report

Merging #1032 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #1032      +/-   ##
==========================================
+ Coverage   87.27%   87.29%   +0.01%     
==========================================
  Files         188      188              
  Lines       28739    28742       +3     
==========================================
+ Hits        25082    25089       +7     
+ Misses       3657     3653       -4
Impacted Files Coverage Δ
satpy/readers/aapp_l1b.py 13.5% <0%> (-0.16%) ⬇️
satpy/readers/ami_l1b.py 97.39% <0%> (-0.09%) ⬇️
satpy/tests/reader_tests/test_tropomi_l2.py 94.05% <0%> (+0.24%) ⬆️
satpy/readers/tropomi_l2.py 94.87% <0%> (+0.58%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c80a510...c522656. Read the comment docs.

@mraspaud
Copy link
Member

mraspaud commented Jan 8, 2020

You write that if it's at least 2 dimensions, it should also have x, so we can't have y and z only ? (eg caliop)

@djhoese
Copy link
Member Author

djhoese commented Jan 8, 2020

Good point. I'll update that in a bit.

Copy link
Member

@mraspaud mraspaud left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mraspaud mraspaud merged commit d5be3aa into pytroll:master Jan 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants