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

Add toggle_implementation to the sphinx documentation #287

Open
robrap opened this issue Jul 3, 2023 · 0 comments
Open

Add toggle_implementation to the sphinx documentation #287

robrap opened this issue Jul 3, 2023 · 0 comments

Comments

@robrap
Copy link
Contributor

robrap commented Jul 3, 2023

The annotation toggle_implementation should be added to the sphinx documentation, because knowing that a toggle is a “DjangoSetting” vs a “CourseWaffleFlag” gives a lot of information around the capabilities of the toggle and how and where to configure it, once you understand each type of implementation.

See https://discuss.openedx.org/t/which-toggle-annotations-should-be-published/4690

Question:

  • Is it enough to capture this decision in the commit comment vs an ADR?
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

No branches or pull requests

1 participant