Opened 6 months ago

Closed 6 months ago

#36311 closed Cleanup/optimization (fixed)

Inconsistent spelling in docs for a few words

Reported by: Natalia Bidart Owned by: Ahmed Nassar
Component: Documentation Version: 5.2
Severity: Normal Keywords:
Cc: Triage Stage: Ready for checkin
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

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.

Change History (8)

comment:1 by Sarah Boyce, 6 months ago

Triage Stage: UnreviewedAccepted

Agree with the logic, accepting

comment:2 by David Smith, 6 months ago

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

comment:3 by Ahmed Nassar, 6 months ago

Owner: set to Ahmed Nassar
Status: newassigned

comment:4 by Ahmed Nassar, 6 months ago

Has patch: set

in reply to:  2 comment:5 by Natalia Bidart, 6 months ago

Replying to 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 Cambridge dictionary also list it as a verb, which supports this choice.

comment:6 by Natalia Bidart, 6 months ago

Triage Stage: AcceptedReady for checkin

comment:7 by nessita <124304+nessita@…>, 6 months ago

In abbcef52:

Refs #36311 -- Unified spelling of "flatpage" in docs/ref/contrib/flatpages.txt.

comment:8 by nessita <124304+nessita@…>, 6 months ago

Resolution: fixed
Status: assignedclosed

In be40289:

Fixed #36311 -- Unified spelling of "hardcode" and its variants in docs.

Co-authored-by: Natalia <124304+nessita@…>

Note: See TracTickets for help on using tickets.
Back to Top