search

pytroll / pygac

A python package to read and calibrate NOAA and Metop AVHRR GAC and LAC data
https://pygac.readthedocs.org/
GNU General Public License v3.0
20 stars 25 forks source link

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

Closed djhoese closed 2 years ago

djhoese commented 2 years ago

Direct Usage:

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

says get_reader_cls.

Actual code:

https://github.com/pytroll/pygac/blob/c5dcb3204cbb5602246157927f6564633f3bc11c/pygac/__init__.py#L34

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 commented 2 years ago

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