Skip to content

Deprecate gSSURGO.Query #3697

@dlebauer

Description

@dlebauer
  1. add a deprecated roxygen tag w/ message
    #' @deprecated Use [extract_soil_gssurgo()] with soilDB instead.
  2. add .Deprecated("extract_soil_gssurgo") to the top line of the function
    gSSURGO.Query <- function(...) {
      .Deprecated("extract_soil_gssurgo")
      # keep the rest of the function as is
  3. remove any tests of the function
  4. add notes to NEWS and CHANGELOG
  5. document "how to deprecate a function" to the coding style section of docs; link to PR as example
  6. While editing docs, also include "Removing deprecated functions" for removing the function in a later release
    • Remove function from the codebase and NAMESPACE along with any remaining tests.
    • git rm the Rd file

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions