Summary
reproject() in xrspatial/reproject spells the source/target concept two ways in one signature.
Horizontal CRS parameters use full words: source_crs, target_crs.
Vertical datum parameters use the abbreviated forms: src_vertical_crs, tgt_vertical_crs.
A caller passing both a horizontal and a vertical CRS in the same call has to remember that one pair is spelled out and the other is abbreviated.
Proposed change
Rename the vertical parameters to match the horizontal ones:
src_vertical_crs -> source_vertical_crstgt_vertical_crs -> target_vertical_crs
A rename breaks existing callers, so keep the old names working: accept both spellings, emit a DeprecationWarning when an old name is passed, and update the docstring to the new names.
Scope
Only reproject() takes these vertical parameters. merge() does not expose them. itrf_transform() uses src/tgt for ITRF frame names, a separate function family that is out of scope here.
Found by the api-consistency sweep (Cat 1, parameter naming drift).
Summary
reproject()inxrspatial/reprojectspells the source/target concept two ways in one signature.Horizontal CRS parameters use full words:
source_crs,target_crs.Vertical datum parameters use the abbreviated forms:
src_vertical_crs,tgt_vertical_crs.A caller passing both a horizontal and a vertical CRS in the same call has to remember that one pair is spelled out and the other is abbreviated.
Proposed change
Rename the vertical parameters to match the horizontal ones:
src_vertical_crs->source_vertical_crstgt_vertical_crs->target_vertical_crsA rename breaks existing callers, so keep the old names working: accept both spellings, emit a
DeprecationWarningwhen an old name is passed, and update the docstring to the new names.Scope
Only
reproject()takes these vertical parameters.merge()does not expose them.itrf_transform()usessrc/tgtfor ITRF frame names, a separate function family that is out of scope here.Found by the api-consistency sweep (Cat 1, parameter naming drift).