cfpb / django-flags

Feature flags for Django projects
https://cfpb.github.io/django-flags/
Creative Commons Zero v1.0 Universal
260 stars 32 forks source link

Document the flagged-class-based view API #32

Closed willbarton closed 5 years ago

willbarton commented 5 years ago

This PR adds documentation for the FlaggedViewMixin and FlaggedTemplateView classes that provide options for flagging class-based views.

It also deprecates the condition attribute on FlaggedViewMixin. The term "condition" has come to mean the thing that evaluates the state of the flag, rather than the expected evaluation. Using condition will not warn about its deprecation and recommend using state instead. This is now consistent with the use of the terms condition and state elsewhere in the Django-Flags API.

It also changes all our links to the Django 2.x docs to upcoming LTS release 2.2.

This PR will close #29.