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

WAFFLE_SWITCH_MODEL is missing from the "Configuring Waffle" docs page #454

Open
allanlewis opened this issue Aug 16, 2022 · 3 comments · May be fixed by #535
Open

WAFFLE_SWITCH_MODEL is missing from the "Configuring Waffle" docs page #454

allanlewis opened this issue Aug 16, 2022 · 3 comments · May be fixed by #535

Comments

@allanlewis
Copy link

The setting WAFFLE_SWITCH_MODEL allows using a custom switch model. It's documented on the Switches page but not on the Configuring Waffle page. For comparison, the equivalent setting for flags, WAFFLE_FLAG_MODEL, is documented on both the Flags and Configuring Waffle pages.

Perhaps there are other settings missing from the Configuring Waffle page? I haven't checked.

@clintonb
Copy link
Collaborator

Feel free to submit a pull request with a fix.

@allanlewis
Copy link
Author

If someone can supply a description of WAFFLE_SWITCH_MODEL for the docs I'd be happy to raise a PR; I'm not sure how to describe it myself.

@dancergraham
Copy link
Contributor

Suggested description:

WAFFLE_SWITCH_MODEL
The Django model that will be used for switches. Defaults to waffle.Switch, which provides basic switch functionality. This can be swapped for a custom Switch model if additional fields or behaviors are needed. The custom model must inherit from waffle.models.AbstractBaseSwitch. Needs to be set at the start of a project, as Django’s migration framework does not support changing swappable models after the initial migration.

dancergraham added a commit to dancergraham/django-waffle that referenced this issue Nov 26, 2024
Fixes jazzband#454

Add `WAFFLE_SWITCH_MODEL` and `WAFFLE_SAMPLE_MODEL` settings to the "Configuring Waffle" documentation page.
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 a pull request may close this issue.

3 participants