-
Notifications
You must be signed in to change notification settings - Fork 303
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
Improvements in custom reader documentation #2104
Conversation
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 Report
@@ 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
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
There was a problem hiding this 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.
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.
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.