#36311: Inconsistent spelling in docs for a few words
-------------------------------------+-------------------------------------
Reporter: Natalia Bidart | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: 5.2 | Severity: Normal
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
While reviewing some PRs, I noticed a few inconsistencies in spelling:
* hardcode(d) / hard code / hard-code
* lookup / look up
* flatpage / flat page
Although tickets are not necessary for documentation changes, I think it
would be helpful to track these and make decisions on the correct spelling
so we can apply them consistently.
For the first case, I think we should use either `hard-code` or `hardcode`
(but not `hard code`, and we should choose one and stick with it).
For the second, it seems that `lookup` is used as a noun or adjective,
while the verb is `look up`. I tend to use `lookup` as a verb in the
context of Django model DB operations, but I wonder if this is technically
incorrect. If it's acceptable, I would be inclined to use `lookup`
everywhere.
For the third, I believe we should use `flatpage` (without a space) when
referring to the specific context of the Django contrib app, unless we're
referring to any page that is flat, in general.
--
Ticket URL: <https://code.djangoproject.com/ticket/36311>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion visit
https://groups.google.com/d/msgid/django-updates/01070196173b06c9-8df2eaec-c1f4-4e6e-9c2d-1ab4e49dbd51-000000%40eu-central-1.amazonses.com.
