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

Improvements in custom reader documentation #2104

Merged
merged 3 commits into from
May 10, 2022

Conversation

gerritholl
Copy link
Member

@gerritholl gerritholl commented May 5, 2022

In the development guide section on writing a custom reader, point out
where the YAML file goes. Also fix various small markup warts and typoes.

  • Fully documented

In the development guide section on writing a custom reader, point out
where the YAML file goes and that NetCDF readers can use the
``NetCDF4FileHandler``.  Also fix various small markup warts and typoes.
@codecov
Copy link

codecov bot commented May 5, 2022

Codecov Report

Merging #2104 (5940f3a) into main (20434bf) will increase coverage by 0.05%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #2104      +/-   ##
==========================================
+ Coverage   93.89%   93.95%   +0.05%     
==========================================
  Files         283      283              
  Lines       42589    42881     +292     
==========================================
+ Hits        39991    40290     +299     
+ Misses       2598     2591       -7     
Flag Coverage Δ
behaviourtests 4.77% <ø> (+0.06%) ⬆️
unittests 94.51% <ø> (+0.05%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
satpy/tests/test_multiscene.py 99.45% <0.00%> (-0.03%) ⬇️
satpy/readers/fci_l2_nc.py 99.45% <0.00%> (-0.01%) ⬇️
satpy/readers/cmsaf_claas2.py 100.00% <0.00%> (ø)
satpy/tests/test_modifiers.py 100.00% <0.00%> (ø)
satpy/tests/test_composites.py 100.00% <0.00%> (ø)
satpy/tests/reader_tests/test_cmsaf_claas.py 100.00% <0.00%> (ø)
satpy/tests/reader_tests/test_seviri_l1b_icare.py 100.00% <0.00%> (ø)
satpy/tests/test_scene.py 99.47% <0.00%> (+0.01%) ⬆️
satpy/readers/fci_l1c_nc.py 98.05% <0.00%> (+0.02%) ⬆️
satpy/tests/test_yaml_reader.py 99.60% <0.00%> (+0.03%) ⬆️
... and 8 more

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 20434bf...5940f3a. Read the comment docs.

Copy link
Member

@djhoese djhoese left a comment

Choose a reason for hiding this comment

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

Very nice. I only have a few small requests.

@coveralls
Copy link

coveralls commented May 5, 2022

Coverage Status

Coverage increased (+0.03%) to 94.453% when pulling 5940f3a on gerritholl:custom-reader-doc-improvements into 56eb21b on pytroll:main.

Add a link to the configuration page.  Remove duplicate mention of
helpper classes.
In the custom reader documentation, simplify the link to the
configuration section.  Remove the anchor there again.
@gerritholl gerritholl requested a review from djhoese May 9, 2022 14:25
@gerritholl gerritholl merged commit 66404f2 into pytroll:main May 10, 2022
@gerritholl gerritholl deleted the custom-reader-doc-improvements branch May 10, 2022 14:05
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.

3 participants