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

Merge pull request #26042 from regisb/regisb/update-waffle-util-adr

Browse Source 
[BD-21] Document non-namespaced waffle classes in ADR
This commit is contained in:
Robert Raposa
2021-01-13 09:56:35 -05:00
committed by GitHub
parent b2822ef3f0 d04d4291f5
commit 50b705405e
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
============