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.

Sign up for GitHub

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

Jump to bottom

Normalise verbose_name and verbose_name_plural for audio models #4655

Closed
dhruvkb opened this issue Jul 24, 2024 · 3 comments · Fixed by #4986
Closed

Normalise verbose_name and verbose_name_plural for audio models #4655

dhruvkb opened this issue Jul 24, 2024 · 3 comments · Fixed by #4986
Assignees
@dryruffian
Labels
💻 aspect: code Concerns the software code in the repository 📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix good first issue New-contributor friendly help wanted Open to participation from the community 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API 🔧 tech: django Involves Django

Comments

@dhruvkb
Copy link
Member

dhruvkb commented Jul 24, 2024

Description

Audio models have either none, or incorrect verbose_name_plural values. Additionally they all lack verbose_name.

Model Current verbose_name_plural Expected verbose_name_plural Expected verbose_name
Audio None "audio tracks" "audio track"
SensitiveAudio "Sensitive audio" "sensitive audio tracks" "sensitive audio track"
DeletedAudio "Deleted audio" "deleted audio tracks" "deleted audio track"

Note the lowercasing of the first letter in verbose_name_plural and the use of "track(s)" to differentiate singular and plural values.

This change will lead to a new no-op migration.

Additional context

These textual changes actually make a significant difference in the experience of moderation as the Django admin uses these values heavily to build menus and pages.
@dhruvkb dhruvkb added good first issue New-contributor friendly help wanted Open to participation from the community 🟨 priority: medium Not blocking but should be addressed soon 🛠 goal: fix Bug fix 📄 aspect: text Concerns the textual material in the repository 💻 aspect: code Concerns the software code in the repository 🧱 stack: api Related to the Django API 🔧 tech: django Involves Django labels Jul 24, 2024
@openverse-bot openverse-bot moved this to 📋 Backlog in Openverse Backlog Jul 24, 2024
@Yadavanurag13
Copy link 

class Meta:
        verbose_name = "Deleted audio"
        verbose_name_plural = "Deleted audios"


class Meta:
        db_table = "api_matureaudio"
        verbose_name = "Sensitive audio"
        verbose_name_plural = "Sensitive audios"

@dhruvkb is this the expected solution?

@dhruvkb
Copy link
Member Author

dhruvkb commented Jul 29, 2024 •
edited
Loading

No @Yadavanurag13. The solution would be to specify the value in the expected columns for verbose_name and verbose_name_plural.

@dryruffian
Copy link
Contributor

Hi @dhruvkb,

class Audio(AudioFileMixin, AbstractMedia):

    class Meta(AbstractMedia.Meta):
        db_table = "audio"
        verbose_name = "audio track"
        verbose_name_plural = "audio tracks"

is this the expected solution and I will also do it for classes SensitiveAudio and DeletedAudio, if its can you please assign this issue to me.

@dryruffian dryruffian mentioned this issue Sep 25, 2024
Merged
8 tasks
@openverse-bot openverse-bot moved this from 📋 Backlog to 🏗 In Progress in Openverse Backlog Sep 25, 2024
@openverse-bot openverse-bot moved this from 🏗 In Progress to ✅ Done in Openverse Backlog Oct 11, 2024
@openverse-bot openverse-bot moved this from ✅ Done to 🏗 In Progress in Openverse Backlog Oct 11, 2024
@dhruvkb dhruvkb moved this from 🏗 In Progress to ✅ Done in Openverse Backlog Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dryruffian dryruffian

Labels
💻 aspect: code Concerns the software code in the repository 📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix good first issue New-contributor friendly help wanted Open to participation from the community 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: api Related to the Django API 🔧 tech: django Involves Django
Projects
Openverse Backlog
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add correct verbose_name and verbose_name_plural to audio models dryruffian/openverse-init
3 participants
@dhruvkb @dryruffian @Yadavanurag13