pecan icon indicating copy to clipboard operation
pecan copied to clipboard
verified publisher icon PecanProject

Deprecate gSSURGO.Query() #3697

Open shivpratikhande opened this issue 3 weeks ago • 3 comments

…G #3697

Description

Marked the gSSURGO.Query() function as deprecated:

  • Added @deprecated roxygen tag.
  • Added .Deprecated("extract_soil_gssurgo") at the top of the function.
  • Kept the rest of the function as-is.
  • Updated NEWS.md and CHANGELOG.md with deprecation notes.
  • Documented the deprecation process in the coding style section.

No tests were related to this function.

Motivation and Context

This change informs users that gSSURGO.Query() is deprecated and directs them to use extract_soil_gssurgo() from soilDB instead. It prepares the function for removal in a future release and links to the issue #3697.

Review Time Estimate

  • [ ] Immediately
  • [ ] Within one week
  • [x] When possible

Types of changes

  • [x] Chore / Maintenance
  • [ ] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • [x] My change requires a change to the documentation.
  • [ ] My name is in the list of CITATION.cff
  • [x] I agree that PEcAn Project may distribute my contribution under any or all of
    • the same license as the existing code,
    • and/or the BSD 3-clause license.
  • [x] I have updated the CHANGELOG.md.
  • [x] I have updated the documentation accordingly.
  • [x] I have read the CONTRIBUTING document.
  • [ ] I have added tests to cover my changes.
  • [x] All new and existing tests passed.

shivpratikhande avatar Dec 04 '25 19:12 shivpratikhande

Oddly, it seems like the most recent commit removed the part we want (documentation of deprecation) https://github.com/PecanProject/pecan/commit/f36090a7a74e03d27a1bc2e82dca5383ba529236

dlebauer avatar Dec 05 '25 15:12 dlebauer

Oh, my bad I didn’t realize the deprecation note got removed I’ll fix the file; would you prefer I update this PR or open a new one?

shivpratikhande avatar Dec 05 '25 16:12 shivpratikhande

Just regenerate the docs using devtools::document("modules/data.land") This will auto-generate modules/data.land/man/gSSURGO.Query.Rd , no need to edit it manually since it's produced from the roxygen comments. After regeneration commit the updated .Rd file.

divine7022 avatar Dec 05 '25 16:12 divine7022