Skip to content

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

Merged
snowman2 merged 1 commit into
vylor:masterfrom
dylanpulver:doc/write-gcps-parameter-name
Nov 18, 2026
Merged

snowman2 merged 1 commit into
vylor:masterfrom
dylanpulver:doc/write-gcps-parameter-name

Conversation

@dylanpulver

Copy link
Copy Markdown
Contributor

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.
@snowman2 snowman2 added this to the 0.24.1 milestone Nov 18, 2026
@snowman2 snowman2 added bug Something isn't working documentation Documentation related issue labels Nov 18, 2026
@codecov

codecov Bot commented Nov 18, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.91%. Comparing base (ae6635a) to head (743dcac).
⚠️ Report is 239 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff            @@
##           master     #960    +/-   ##
========================================
  Coverage   95.90%   95.91%            
========================================
  Files          12       18     +6     
  Lines        1735     2106   +371     
========================================
+ Hits         1664     2020   +356     
- Misses         71       86    +15     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@snowman2
snowman2 merged commit 7438389 into vylor:master Nov 18, 2026
16 of 19 checks passed
@snowman2

Copy link
Copy Markdown
Member

Thanks @dylanpulver 👍

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

Labels

bug Something isn't working documentation Documentation related issue

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants