[Django] #36311: Inconsistent spelling in docs for a few words

[Django]

#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.

[Django]

#36311: Inconsistent spelling in docs for a few words

--------------------------------------+------------------------------------
Reporter: Natalia Bidart | Owner: (none)

Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 5.2

Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

--------------------------------------+------------------------------------
Changes (by Sarah Boyce):

* stage: Unreviewed => Accepted

Comment:

Agree with the logic, accepting
--
Ticket URL: <https://code.djangoproject.com/ticket/36311#comment:1>

[Django]

#36311: Inconsistent spelling in docs for a few words
--------------------------------------+------------------------------------
Reporter: Natalia Bidart | Owner: (none)
Type: Cleanup/optimization | Status: new
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
--------------------------------------+------------------------------------

Comment (by David Smith):

The AP style book doesn't have hard code but does have hard line which is
likely close enough.

"Hard line" (n)
"Hard-liner" (n)
"Hard-line" (adj.)
--
Ticket URL: <https://code.djangoproject.com/ticket/36311#comment:2>

[Django]

#36311: Inconsistent spelling in docs for a few words

-------------------------------------+-------------------------------------
Reporter: Natalia Bidart | Owner: Ahmed
Type: | Nassar
Cleanup/optimization | Status: assigned

Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0

-------------------------------------+-------------------------------------
Changes (by Ahmed Nassar):

* owner: (none) => Ahmed Nassar
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/36311#comment:3>

[Django]

#36311: Inconsistent spelling in docs for a few words
-------------------------------------+-------------------------------------
Reporter: Natalia Bidart | Owner: Ahmed
Type: | Nassar
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Ahmed Nassar):

* has_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36311#comment:4>

[Django]

#36311: Inconsistent spelling in docs for a few words
-------------------------------------+-------------------------------------
Reporter: Natalia Bidart | Owner: Ahmed
Type: | Nassar
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by Natalia Bidart):

Replying to [comment:2 David Smith]:

> The AP style book doesn't have hard code but does have hard line which
is likely close enough.
>
> "Hard line" (n)
> "Hard-liner" (n)
> "Hard-line" (adj.)

Thank you, David. I did look into those, and also considered "hard core"
as a similar reference. That said, given the majority of existing uses for
`hardcode`, particularly in the Django docs and other technical contexts,
I lean toward `hardcode` as the preferred form. Other sources like the
[https://dictionary.cambridge.org/dictionary/english/hardcode Cambridge
dictionary] also list it as a verb, which supports this choice.
--
Ticket URL: <https://code.djangoproject.com/ticket/36311#comment:5>

[Django]

#36311: Inconsistent spelling in docs for a few words
-------------------------------------+-------------------------------------
Reporter: Natalia Bidart | Owner: Ahmed
Type: | Nassar
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:

Keywords: | Triage Stage: Ready for
| checkin

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by Natalia Bidart):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/36311#comment:6>

[Django]

#36311: Inconsistent spelling in docs for a few words
-------------------------------------+-------------------------------------
Reporter: Natalia Bidart | Owner: Ahmed
Type: | Nassar
Cleanup/optimization | Status: assigned
Component: Documentation | Version: 5.2
Severity: Normal | Resolution:
Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Comment (by nessita <124304+nessita@…>):

In [changeset:"abbcef52801f920caf72f4e2016c4999ea8b98ec" abbcef52]:
{{{#!CommitTicketReference repository=""
revision="abbcef52801f920caf72f4e2016c4999ea8b98ec"
Refs #36311 -- Unified spelling of "flatpage" in
docs/ref/contrib/flatpages.txt.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36311#comment:7>

[Django]

#36311: Inconsistent spelling in docs for a few words
-------------------------------------+-------------------------------------
Reporter: Natalia Bidart | Owner: Ahmed
Type: | Nassar

Cleanup/optimization | Status: closed
Component: Documentation | Version: 5.2
Severity: Normal | Resolution: fixed

Keywords: | Triage Stage: Ready for
| checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------

Changes (by nessita <124304+nessita@…>):

* resolution: => fixed
* status: assigned => closed

Comment:

In [changeset:"be402891cd78f484b7f67e486924975523516ced" be40289]:
{{{#!CommitTicketReference repository=""
revision="be402891cd78f484b7f67e486924975523516ced"
Fixed #36311 -- Unified spelling of "hardcode" and its variants in docs.

Co-authored-by: Natalia <124304+...@users.noreply.github.com>
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36311#comment:8>