#37012 closed Cleanup/optimization (wontfix)

Improve punctuation and sentence clarity in templates documentation

Reported by: AKSHAT MAKWANA Owned by:
Component: Documentation Version: 6.0
Severity: Normal Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

Description

In the templates documentation, a sentence uses a comma where a semicolon would improve readability and separation of clauses.

Current text

"You can also write your own custom backend, see :doc:Custom template backend </howto/custom-template-backend>"

Proposed change

"You can also write your own custom backend; see :doc:Custom template backend </howto/custom-template-backend>."

Rationale

This improves grammatical correctness and clarity by properly separating independent clauses and ensuring correct punctuation.

I would be happy to submit a patch for this improvement.

Change History (1)

comment:1 by Jacob Walls, 93 minutes ago

Resolution: wontfix
Status: newclosed

Yes, it's a comma splice, but I read it as if there's an omitted ("e.g.") --> "You can foo, for example, see bar."

I don't think it's worth auditing. I'm sure there's instances all over.

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