Skip to content

MNT: Implement a @deprecated decorator #669

@Gui-FernandesBR

Description

@Gui-FernandesBR

The @deprecated decorator is used to mark functions or methods as deprecated, indicating that they will be removed in future versions. This helps in managing deprecations and informing users of the codebase about outdated functionalities.
This could help us to organize the code and manage deprecations.

Basic Implementation Steps:

  • Create a decorator function named deprecated.
  • The decorator should issue a warning when the decorated function is called, indicating that it is deprecated.
  • Include a message or version information in the warning to provide more context.
  • Search in the code any deprecation messages and use the decorator you created.

OBS.: Please be aware of 2 different status we may have:

  • 1: The method is already deprecated.
  • 2: The method is set to be deprecated in a future version (this happens when we want to deprecate something, but we are obligated to give users some time ahead).

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    Status

    Closed

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions