search

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

Per-flag documentation using help_text #65

Open jonwhittlestone opened 4 years ago

jonwhittlestone commented 4 years ago

Suggestion: A way for Django Admin users to view tooltips/help text about the purpose of a flag

How: Use the Django model instance property help_text

https://docs.djangoproject.com/en/3.0/ref/models/fields/#help-text

Proposed Usage: Specify in the settings

    'FLAG_DOES_A_THING': [{'condition': 'boolean', 'value': False, 'help_text': 'When set to True, this will do something great'}],

Does django-flags already have a way to achieve something similar?

willbarton commented 4 years ago

@jonwhittlestone this is a fantastic idea! I know @Scotchester had had a similar idea around adding metadata to flags/conditions like this.

It does not currently have a way to do this. In cfgov-refresh, we try to define all our flags in settings so that we can use comments for this purpose, but it doesn't help admin users.