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

Clean up redundant and confusing names in models to improve admin interface #1420

Open
jonespm opened this issue Sep 1, 2022 · 0 comments
Open

Comments

@jonespm
Copy link
Member

jonespm commented Sep 1, 2022

Two issues were noticed in the models.py file that could be improved.

  1. If the verbose_name matches the name of the field just remove the verbose name as it automatically matches. This follows Django's Less Code and DRY principles.

  2. If the verbose name could be improved we should do that.

  3. Additionally we don't use help_text to provide even more additional text on forms. It's possible some of these fields could have useful text. This should be figured out with @jennlove-um what these might be.

This appears under fields on the form like
image

I'm thinking we might want to have text like

  • Name, Start/End Date: "This field will be automatically populated by cron to match Canvas but can be adjusted if desired"
  • Data last updated: "This is the last time the cron was run and can be reset on the main courses page with the dropdown"

There's probably others., especially like the course view option area.

Originally posted by @jonespm in #1410 (comment)

@jonespm jonespm changed the title Clean up redundant and confusing names in models. Clean up redundant and confusing names in models to improve admin interface Sep 1, 2022
@jennlove-um jennlove-um added this to To do in MyLA-Default-Project via automation Feb 15, 2023
@jonespm jonespm added the good first issue Good for newcomers label Apr 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Development

No branches or pull requests

1 participant