[Django] #37012: Improve punctuation and sentence clarity in templates documentation

5 views
Skip to first unread message

Django

unread,
Mar 30, 2026, 11:49:53 AMMar 30
to django-...@googlegroups.com
#37012: Improve punctuation and sentence clarity in templates documentation
-------------------------------------+-------------------------------------
Reporter: AKSHAT MAKWANA | Type:
| Cleanup/optimization
Status: new | Component:
| Documentation
Version: 6.0 | 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
-------------------------------------+-------------------------------------
**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.
--
Ticket URL: <https://code.djangoproject.com/ticket/37012>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

Django

unread,
Mar 30, 2026, 11:59:35 AMMar 30
to django-...@googlegroups.com
#37012: Improve punctuation and sentence clarity in templates documentation
-------------------------------------+-------------------------------------
Reporter: AKSHAT MAKWANA | Owner: (none)
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 6.0
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Changes (by Jacob Walls):

* resolution: => wontfix
* status: new => closed

Comment:

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.
--
Ticket URL: <https://code.djangoproject.com/ticket/37012#comment:1>
Reply all
Reply to author
Forward
0 new messages