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

Per-flag documentation using help_text #65

Open
jonwhittlestone opened this issue May 27, 2020 · 1 comment
Open

Per-flag documentation using help_text #65

jonwhittlestone opened this issue May 27, 2020 · 1 comment

Comments

@jonwhittlestone
Copy link

jonwhittlestone commented May 27, 2020

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
Copy link
Member

willbarton commented May 27, 2020

@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.

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

2 participants