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

Documentation bug: group_files keyword argument reader doc has sentence consisting of only the word "This" #1144

Closed
gerritholl opened this issue Apr 15, 2020 · 1 comment · Fixed by #1147

Comments

@gerritholl
Copy link
Member

Describe the bug

The [documentation for satpy.readers.group_files, keyword argument reader, is as follows:

Reader whose file patterns should be used to sort files. This

The second sentence is just "This", and appears broken off.

To Reproduce

Expected behavior

I expect complete sentences explaining the use of the keyword argument reader.

Actual results

I'm getting an incomplete sentence consisting of only the word "This".

Screenshots

grafik

Environment Info:

Version "latest" on readthedocs as of 2020-04-15.

Additional context

I suspect this sentence was intended to say something about this keyword argument being optional or mandatory or how it is being used.

@djhoese
Copy link
Member

djhoese commented Apr 15, 2020

I would say this is incomplete rather than a bug. I started typing something and got distracted and never went back to finish it.

Edit: I'll see if I can figure out what I wanted to say later today and make a PR.

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