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

Update custom reader documentation to mention coordinates and available datasets #782

Closed
djhoese opened this issue May 19, 2019 · 2 comments · Fixed by #1019
Closed

Update custom reader documentation to mention coordinates and available datasets #782

djhoese opened this issue May 19, 2019 · 2 comments · Fixed by #1019

Comments

@djhoese
Copy link
Member

djhoese commented May 19, 2019

Custom reader documentation currently only mentions creating a gridded area definition, but should also mention creating a SwathDefinition via the coordinates parameter in the YAML.

Other things that could/should be added (I'll add more if I think of them):

  • available_dataset_ids, at least a sentence or two about it and pointing to the more thorough API docs
@gerritholl
Copy link
Member

It would also be helpful to point out explicitly that it's not mandatory to list all the available datasets in the yaml file; for a NetCDF file with lots of datasets, this just duplicates the self-documenting NetCDF header.

@djhoese
Copy link
Member Author

djhoese commented Dec 13, 2019

Wow, I'm sorry @gerritholl. I really thought I added it to the custom reader documentation. Long overdue. I'll see if I can get to this later today.

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.

2 participants