Skip to content

Commit

Permalink
docs: introduce REMOVE-AFTER-VXX comment convention for deprs
Browse files Browse the repository at this point in the history
  • Loading branch information
kdmccormick committed Oct 16, 2023
1 parent 36e7a79 commit 551c631
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
7 changes: 7 additions & 0 deletions docs/tutor.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,13 @@ An optional BRANCH suffix may be appended to the release name to indicate that e

`Officially-supported plugins <https://overhang.io/tutor/plugins>`__ follow the same versioning pattern. As a third-party plugin developer, you are encouraged to use the same pattern to make it immediately clear to your end-users which Open edX versions are supported.

In Tutor and its officially-supported plugins, certain features, API endpoints, and older depenency versions are periodically deprecated. Generally, warnings are added to the Changelogs and/or the command-line interface one major release before support for any behavior is removed. In order to keep track of pending removals in the source code, comments containing the string ``REMOVE-AFTER-VXX`` should be used, where ``<XX>`` is the last major version that must support the behavior. For example::

# This has been replaced with SOME_NEW_HOOK (REMOVE-AFTER-V25).
SOME_OLD_HOOK = Filter()

indicates that this filter definition can be removed as soon as Tutor v26.0.0.

.. _contributing:

Contributing to Tutor
Expand Down
3 changes: 2 additions & 1 deletion tutor/env.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@ def _prepare_environment() -> None:
("HOST_USER_ID", utils.get_user_id()),
("TUTOR_APP", __app__.replace("-", "_")),
("TUTOR_VERSION", __version__),
# For backwards compatability. Remove after Quince.
# BuildKit used to be optional. Now, it's always enabled.
# This constant is just for temporary backwards compatibility (REMOVE-AFTER-V16).
("is_buildkit_enabled", lambda: True),
],
)
Expand Down

0 comments on commit 551c631

Please sign in to comment.