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

Usage documentation uses wrong function name for 'get_reader_class' #112

Closed
djhoese opened this issue Aug 21, 2022 · 1 comment · Fixed by #113
Closed

Usage documentation uses wrong function name for 'get_reader_class' #112

djhoese opened this issue Aug 21, 2022 · 1 comment · Fixed by #113
Assignees

Comments

@djhoese
Copy link
Member

djhoese commented Aug 21, 2022

Direct Usage:

https://github.com/pytroll/pygac/blob/main/doc/source/usage.rst#direct-usage

says get_reader_cls.

Actual code:

from pygac.runner import get_reader_class, process_file # noqa

I'm not familiar with this code otherwise so I'm not sure what else might be wrong in this documentation. One of the maintainers should review all function calls in this documentation.

@carloshorn
Copy link
Collaborator

Definitely a typo in the documentation. The function get_reader_class selects the appropriate reader for a given file (LAC/GAC, POD/KLT).

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.

3 participants