Skip to content

Migrate to use keyword-only arguments #3324

@higucheese

Description

@higucheese

Motivation

Current function calls using positional arguments limit changes to function signatures by developers in order to minimize code changes on the user side. In contrast, keyword arguments allow them to change the signature freely, with exceptions such as reducing the number of arguments.

Description

By making all arguments of major functions such as create_study / load_study keyword-only arguments, developers can change the signatures without changing on the userside. Conventional calls with positional arguments will be changed to keyword-only arguments internally, so that user code will not be affected. At least in v3, it would be better to only issue a FutureWarning for the use of positional arguments, and depending on the response, consider whether we should unify the use of keyword-only arguments.

Alternatives (optional)

No response

Additional context (optional)

Metadata

Metadata

Assignees

No one assigned

    Labels

    featureChange that does not break compatibility, but affects the public interfaces.no-staleExempt from stale bot

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions