Skip to content

Conversation

AntonBallmaier
Copy link
Contributor

@AntonBallmaier AntonBallmaier commented Apr 25, 2021

Changelog / Overview

Added two function decorators deprecated and deprecated_params as a consistent way of deprecating code.

Motivation

see #1372
Closes #1372

Explanation for Changes

Have a look at the docs...

Testing Status

Further Comments

Checklist

  • I have read the Contributing Guidelines
  • I have written a descriptive PR title (see top of PR template for examples)
  • I have written a changelog entry for the PR or deem it unnecessary
  • My new functions/classes either have a docstring or are private
  • My new functions/classes have tests added and (optional) examples in the docs
  • My new documentation builds, looks correctly formatted, and adds no additional build warnings

Reviewer Checklist

  • The PR title is descriptive enough
  • The PR is labeled correctly
  • The changelog entry is completed if necessary
  • Newly added functions/classes either have a docstring or are private
  • Newly added functions/classes have tests added and (optional) examples in the docs
  • Newly added documentation builds, looks correctly formatted, and adds no additional build warnings

Copy link
Contributor

@RickyC0626 RickyC0626 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just some minor documentation and typo changes. I think this is a great feature for internal use, but if we were to release this feature as a separate package, internationalization support for the warning messages would be a big plus.

@AntonBallmaier AntonBallmaier requested a review from naveen521kk May 5, 2021 11:06
Copy link
Member

@naveen521kk naveen521kk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SGTM

@RickyC0626
Copy link
Contributor

Perhaps we can introduce some decorator utility commands in another PR.

@huguesdevimeux huguesdevimeux merged commit 71b86d5 into ManimCommunity:master May 11, 2021
behackl pushed a commit that referenced this pull request May 11, 2021
* Remove stray print statements introduced in #1404

* Update lock file
@AntonBallmaier AntonBallmaier deleted the decorators branch May 15, 2021 15:05
@behackl behackl changed the title Deprecation Decorators Added two deprecation parameters May 31, 2021
@behackl behackl changed the title Added two deprecation parameters Added two deprecation decorators May 31, 2021
@behackl behackl added infrastructure Anything related to our infrastructure maintenance refactoring, typos, removing clutter/dead code, and other code quality improvements new feature Enhancement specifically adding a new feature (feature request should be used for issues instead) and removed infrastructure Anything related to our infrastructure labels May 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

maintenance refactoring, typos, removing clutter/dead code, and other code quality improvements new feature Enhancement specifically adding a new feature (feature request should be used for issues instead)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Implementing an official and stable deprecation system

7 participants