Skip to content

Consistency between CLI and Python interfaces. #486

@oerc0122

Description

@oerc0122

Currently, there are some cases (e.g. temp_max, temp_min vs. temp_start, temp_end) where python keywords do not align with CLI. These should be made uniform.

In order to rectify this, depending on how we feel about API breaking changes at this stage, we can do the following.

If CLI name adopted in Python:

  • rename the positional argument to the new name
  • Add the alias (old) term to KW only block
  • Raise DeprecationWarning on using old kw.

If Python name adopted in CLI:

  • Add new term as option
  • Move the alias (old) term to a new argument group (c.f. Group CLI options #484) (Deprecated)
  • Raise DeprecationWarning on using old term.

If we're not that concerned (code considered beta?) we can just rename the terms as is and update the tutorials accordingly.

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions