Skip to content
This repository was archived by the owner on Jan 19, 2025. It is now read-only.
This repository was archived by the owner on Jan 19, 2025. It is now read-only.

Migrate @enum annotations #1125

@Aclrian

Description

@Aclrian

Is your feature request related to a problem?

After changes to an API we still want to use most of the @enum annotations, if the type of the parameter is not changed.

Desired solution

Migrate the @enum annotations through a mapping from old api elements to new api elements. If there is not more than one similar api element, and it requires string values, change the target of the annotation.
Otherwise, mark all similar api elements which parameter types are str with a @todo annotation. If there is only one such element, use an unsure @enum annotation.

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

Create the file package_parser/processing/migration/annotations/_migrate_enum_annotation.py with a function to migrate an annotation with the related mapping.
See #1120.

Metadata

Metadata

Assignees

Labels

@enumRelated to the @enum annotationenhancement 💡New feature or requestmigrationMigration of annotation to a new API versionreleasedIncluded in a release

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions