Merge pull request #80 from WordPress/help_text

openverse-api/catalog/api/migrations/0030_help_text.py

@@ -0,0 +1,53 @@
+# Generated by Django 2.2.16 on 2021-05-28 04:25
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0029_auto_20210503_1040'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='deletedimage',
+            name='identifier',
+            field=models.UUIDField(help_text='The identifier of the deleted media.', primary_key=True, serialize=False, unique=True),
+        ),
+        migrations.AlterField(
+            model_name='image',
+            name='identifier',
+            field=models.UUIDField(db_index=True, help_text='Our unique identifier for an open-licensed work.', unique=True),
+        ),
+        migrations.AlterField(
+            model_name='image',
+            name='provider',
+            field=models.CharField(blank=True, db_index=True, help_text='The content provider, e.g. Flickr, Jamendo...', max_length=80, null=True),
+        ),
+        migrations.AlterField(
+            model_name='image',
+            name='source',
+            field=models.CharField(blank=True, db_index=True, help_text='The source of the data, meaning a particular dataset. Source and provider can be different. Eg: the Google Open Images dataset is source=openimages, but provider=flickr.', max_length=80, null=True),
+        ),
+        migrations.AlterField(
+            model_name='image',
+            name='url',
+            field=models.URLField(help_text='The actual URL to the media file.', max_length=1000, unique=True),
+        ),
+        migrations.AlterField(
+            model_name='imagereport',
+            name='description',
+            field=models.TextField(blank=True, help_text='The explanation on why media is being reported.', max_length=500, null=True),
+        ),
+        migrations.AlterField(
+            model_name='imagereport',
+            name='identifier',
+            field=models.UUIDField(help_text='The ID for media to be reported.'),
+        ),
+        migrations.AlterField(
+            model_name='imagereport',
+            name='reason',
+            field=models.CharField(choices=[('mature', 'mature'), ('dmca', 'dmca'), ('other', 'other')], help_text='The reason to report media to Openverse.', max_length=20),
+        ),
+    ]

openverse-api/catalog/api/models/media.py

@@ -23,7 +23,7 @@ class AbstractMedia(OpenLedgerModel):
     identifier = models.UUIDField(
         unique=True,
         db_index=True,
-        help_text="Our unique identifier for a CC work."
+        help_text="Our unique identifier for an open-licensed work."
     )
     foreign_identifier = models.CharField(
         unique=True,
@@ -44,7 +44,7 @@ class AbstractMedia(OpenLedgerModel):
     url = models.URLField(
         unique=True,
         max_length=1000,
-        help_text="The actual URL to the image."
+        help_text="The actual URL to the media file."
     )
     filesize = models.IntegerField(blank=True, null=True)
     watermarked = models.NullBooleanField(blank=True, null=True)
@@ -60,15 +60,15 @@ class AbstractMedia(OpenLedgerModel):
         blank=True,
         null=True,
         db_index=True,
-        help_text="The content provider, e.g. Flickr, 500px...")
+        help_text="The content provider, e.g. Flickr, Jamendo...")
     source = models.CharField(
         max_length=80,
         blank=True,
         null=True,
         db_index=True,
-        help_text="The source of the data, meaning a particular dataset. Source"
-                  " and provider can be different: the Google Open Images "
-                  "dataset is source=openimages., but provider=Flickr."
+        help_text="The source of the data, meaning a particular dataset. "
+                  "Source and provider can be different. Eg: the Google Open "
+                  "Images dataset is source=openimages, but provider=flickr."
     )
     last_synced_with_source = models.DateTimeField(
         blank=True,
@@ -147,18 +147,18 @@ class AbstractMediaReport(models.Model):
     created_at = models.DateTimeField(auto_now_add=True)
 
     identifier = models.UUIDField(
-        help_text="The ID for image to be reported."
+        help_text="The ID for media to be reported."
     )
     reason = models.CharField(
         max_length=20,
         choices=REPORT_CHOICES,
-        help_text="The reason to report image to Creative Commons."
+        help_text="The reason to report media to Openverse."
     )
     description = models.TextField(
         max_length=500,
         blank=True,
         null=True,
-        help_text="The explanation on why image is being reported."
+        help_text="The explanation on why media is being reported."
     )
     status = models.CharField(
         max_length=20,
@@ -179,7 +179,7 @@ class AbstractDeletedMedia(OpenLedgerModel):
     identifier = models.UUIDField(
         unique=True,
         primary_key=True,
-        help_text="The identifier of the deleted image."
+        help_text="The identifier of the deleted media."
     )
 
     class Meta: