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

In admin dashboard, convert all field docstrings and user-facing inline comments into help text instead #779

Open
n8kim1 opened this issue Apr 26, 2024 · 0 comments
Labels
good first issue module: backend Related to the Siarnaq backend module priority: p3 low type: doc Improvements or additions to documentation type: refactor Codebase refactors or structure changes

Comments

@n8kim1
Copy link
Contributor

n8kim1 commented Apr 26, 2024

See here: https://docs.djangoproject.com/en/4.1/ref/models/fields/#help-text
Django allows for info to be directly displayed in the admin dashboard frontend, as tooltips, etc. This is much better than relying on comments in the code, which an end user who uses the dashboard might miss.

Great first issue!! To set up the whole backend stack, and to end up trawling through info about all of the backend too!

@n8kim1 n8kim1 added type: doc Improvements or additions to documentation module: backend Related to the Siarnaq backend module priority: p3 low type: refactor Codebase refactors or structure changes good first issue labels Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue module: backend Related to the Siarnaq backend module priority: p3 low type: doc Improvements or additions to documentation type: refactor Codebase refactors or structure changes
Projects
None yet
Development

No branches or pull requests

1 participant