Skip to content

DOC: name the write_gcps parameter as the signature defines it - #960

Open
dylanpulver wants to merge 1 commit into
vylor:masterfrom
dylanpulver:doc/write-gcps-parameter-name
Open

dylanpulver wants to merge 1 commit into
vylor:masterfrom
dylanpulver:doc/write-gcps-parameter-name

Conversation

@dylanpulver

Copy link
Copy Markdown

XRasterBase.write_gcps takes gcps, but the Parameters entry calls it gcp, so write_gcps(gcp=...) raises TypeError for anyone following the docstring. The description already reads "The Ground Control Points to integrate to the dataset", plural.

One line, no behaviour change. pre-commit run --files rioxarray/rioxarray.py passes black, isort, blacken-docs and flake8.

I left docs/history.rst alone, since a one-line docstring name does not look like it belongs there, but say the word and I will add an entry.

write_gcps takes `gcps`, and the Parameters entry called it `gcp`, so
write_gcps(gcp=...) raises TypeError. The description already reads
"The Ground Control Points", plural.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant