Andal.LND/edx-platform
6
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Document non-namespaced waffle classes in ADR

Browse Source 
It was finally decided not to use `skip_namespace_assertion` optional
arguments, but `NonNamespacedWaffle*` classes. We update the ADR to reflect
this change.
This commit is contained in:
Régis Behmo
2021-01-12 16:57:48 +01:00
parent 177c1a530f
commit d04d4291f5
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
openedx/core/djangoapps/waffle_utils/docs/decisions/0004-waffle-util-namespacing.rst
View File

@@ -24,7 +24,7 @@ Decision
Change the interface to WaffleFlag and WaffleSwitch to simply take the complete flag name, rather than a Namespace object.
The constructor can assert that the name includes a `.` to help remind people to use some form of prefixed namespace. However, an optional argument with a name like `skip_namespace_assertion=True` could be used to skip this assertion, enabling a simpler transition for existing flags and switches that don't meet this requirement.
The constructor can assert that the name includes a dot (``.``) to help remind people to use some form of prefixed namespace. Waffle objects which do not include a dot in their name should be converted to ``NonNamespacedWaffleFlag`` or ``NonNamespacedWaffleSwitch`` objects, enabling a simpler transition for existing flags and switches that don't meet this requirement.
Consequences
============