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 @value annotations #1145

@Aclrian

Description

@Aclrian

Is your feature request related to a problem?

After changes to an API, we still want to use most of the @value annotations.

Desired solution

Migrate the @value annotations through a mapping from old api elements to new api elements. If there is not more than one similar api element, change the target of the annotation.
Otherwise, mark all similar api elements with an unsure (?) @value annotation.
If it is a @constant, or @ommited, or @optianal annotation, check if the type match (string, number, boolean). Mark non-matching api elements with an unsure @todo annotation.

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

See #1125 for an example.

Create the file package_parser/processing/migration/annotations/_migrate_value_annotation.py with a function to migrate an annotation with the related mapping. Consider splitting the function into multiple functions for each subtype of @value annotations.

Metadata

Metadata

Assignees

Labels

@valueRelated to the @value 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