Skip to content

FC-0001: rename toggle_warnings to toggle_warning #215

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 23, 2022
Merged

FC-0001: rename toggle_warnings to toggle_warning #215

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Change Log
Unreleased
~~~~~~~~~~

* Rename toggle_warnings to toggle_warning for consistency with setting_warning.

[5.0.0] - 2022-04-22
--------------------

Expand Down
4 changes: 2 additions & 2 deletions docs/how_to/documenting_new_feature_toggles.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Copy-paste this boilerplate template to document a feature toggle::
# .. toggle_description: Add here a detailed description of the consequences of enabling this feature toggle.
# Note that all annotations can be spread over multiple lines by prefixing every line after the first by
# at least three spaces (two spaces plus the leading space).
# .. toggle_warnings: (Optional) Add here additional instructions that users should be aware of. For instance, dependency
# .. toggle_warning: (Optional) Add here additional instructions that users should be aware of. For instance, dependency
# on additional settings or feature toggles should be referenced here. If this field is not needed, simply remove it.
# .. toggle_use_cases: temporary OR circuit_breaker OR vip OR opt_out OR opt_in OR open_edx
# .. toggle_creation_date: 2020-01-01
Expand Down Expand Up @@ -165,7 +165,7 @@ Same toggle in multiple services
If a toggle needs to be synchronized across services:

* The ``toggle_description`` could state that you should read the description for the same toggle in XXX service, rather than duplicating a description.
* The ``toggle_warnings`` should note that the value must be consistent with XXX service. XXX will often be the LMS, but not necessarily.
* The ``toggle_warning`` should note that the value must be consistent with XXX service. XXX will often be the LMS, but not necessarily.

Third-party toggles
-------------------
Expand Down