Skip to content

Discussion: API consistency - language parameter defaults #152

@dshkol

Description

@dshkol

Summary

The language parameter has inconsistent defaults across functions.

Current State

  • R/cansim.R:422 uses language="english"
  • R/cansim.R:956 uses language="en"
  • R/cansim.R:1035 uses language="en"

Proposal

Standardize all defaults to "english" for consistency.

Potential Breaking Change

Users who rely on the current behavior with "en" might be affected, though the internal code likely handles both.

Questions

  • Is standardizing to "english" acceptable?
  • Should we add parameter validation to reject invalid values?
  • How strict should validation be?

From code audit - potentially breaking change for edge cases

Metadata

Metadata

Assignees

No one assigned

    Labels

    questionFurther information is requested

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions