Skip to content

Commit cf48c6a

Browse files
authored
Fix copy issues on model fields (#9170)
* Fix copy issues on model fields The term "domain" is not a proper noun and should not use proper capitalization. We do this in a number of places, as we are generally referring to the underlying model, but this shouldn't be how these terms are communicated to users. I didn't touch the actual copy otherwise, even though we could probably make these descriptions a bit clearer. We could also do that more immediately if it makes sense. * Add migration * Reformat
1 parent 0cdc8ea commit cf48c6a

File tree

2 files changed

+38
-4
lines changed

2 files changed

+38
-4
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Generated by Django 3.2.12 on 2022-05-05 17:29
2+
3+
from django.db import migrations, models
4+
5+
6+
class Migration(migrations.Migration):
7+
8+
dependencies = [
9+
("projects", "0087_use_booleanfield_null"),
10+
]
11+
12+
operations = [
13+
migrations.AlterField(
14+
model_name="domain",
15+
name="canonical",
16+
field=models.BooleanField(
17+
default=False,
18+
help_text="This domain is the primary one where the documentation is served from",
19+
),
20+
),
21+
migrations.AlterField(
22+
model_name="domain",
23+
name="cname",
24+
field=models.BooleanField(
25+
default=False, help_text="This domain is a CNAME for the project"
26+
),
27+
),
28+
migrations.AlterField(
29+
model_name="domain",
30+
name="machine",
31+
field=models.BooleanField(
32+
default=False, help_text="This domain was auto-created"
33+
),
34+
),
35+
]

readthedocs/projects/models.py

+3-4
Original file line numberDiff line numberDiff line change
@@ -1615,17 +1615,16 @@ class Domain(TimeStampedModel, models.Model):
16151615
)
16161616
machine = models.BooleanField(
16171617
default=False,
1618-
help_text=_('This Domain was auto-created'),
1618+
help_text=_("This domain was auto-created"),
16191619
)
16201620
cname = models.BooleanField(
16211621
default=False,
1622-
help_text=_('This Domain is a CNAME for the project'),
1622+
help_text=_("This domain is a CNAME for the project"),
16231623
)
16241624
canonical = models.BooleanField(
16251625
default=False,
16261626
help_text=_(
1627-
'This Domain is the primary one where the documentation is '
1628-
'served from',
1627+
"This domain is the primary one where the documentation is " "served from",
16291628
),
16301629
)
16311630
https = models.BooleanField(

0 commit comments

Comments
 (0)