Skip to content
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.

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

Fix and improve toggle docs #303

Merged
merged 2 commits into from
Aug 21, 2023
Merged

Fix and improve toggle docs #303

merged 2 commits into from
Aug 21, 2023

Conversation

robrap
Copy link
Contributor

@robrap robrap commented Aug 16, 2023

Description:

  • fix: the readthedocs build
  • docs: improve naming recommendations

Related to openedx/edx-platform#33026

Merge checklist:

  • All reviewers approved
  • CI build is green
  • Documentation updated (not only docstrings)
  • Commits are squashed

Adds .readthedocs.yaml to fix the build.
FLAG_FOO.is_enabled()
SWITCH_BAR.is_enabled()
SETTING_TOGGLE_BAZ.is_enabled()
FOO_FLAG.is_enabled()
Copy link
Contributor Author

@robrap robrap Aug 17, 2023

Choose a reason for hiding this comment

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

Note to self: Add examples with new methods (e.g. is_disabled) once #293 lands.

Copy link
Member

@kdmccormick kdmccormick left a comment

Choose a reason for hiding this comment

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

Looks good! Just one suggestion.

docs/how_to/implement_the_right_toggle_type.rst Outdated Show resolved Hide resolved
Provide recommendations around naming various
toggles.

Co-authored-by: Kyle McCormick <[email protected]>
@robrap robrap merged commit ee848b9 into master Aug 21, 2023
8 checks passed
@robrap robrap deleted the robrap/update-docs branch August 21, 2023 18:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants