Opened 8 months ago

Closed 8 months ago

#36918 closed Cleanup/optimization (fixed)

Docs: Minor formatting cleanup

Reported by: $ῗἧḡḥ𝐀丂𝓱м𝑒𝑒𝐓 Owned by: $ῗἧḡḥ𝐀丂𝓱м𝑒𝑒𝐓
Component: Documentation Version: 6.0
Severity: Normal Keywords: docs, formatting, spacing and cleanup
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

Observed minor spacing / formatting inconsistencies in documentation.

This ticket proposes small documentation refinements for improved readability and consistency.

No functional changes.

Change History (10)

comment:1 by $ῗἧḡḥ𝐀丂𝓱м𝑒𝑒𝐓, 8 months ago

Cc: $ῗἧḡḥ𝐀丂𝓱м𝑒𝑒𝐓 added

​https://github.com/django/django/pull/20672

comment:2 by $ῗἧḡḥ𝐀丂𝓱м𝑒𝑒𝐓, 8 months ago

Has patch: set

comment:3 by $ῗἧḡḥ𝐀丂𝓱м𝑒𝑒𝐓, 8 months ago

Triage Stage: Unreviewed → Accepted

comment:4 by Varun Kasyap Pentamaraju, 8 months ago

Triage Stage: Accepted → Unreviewed

comment:5 by Jacob Walls, 8 months ago

Resolution: → invalid
Status: new → closed

Thanks for spotting typos, we don't need tickets for them, though. Can continue on the PR.

in reply to:  3 comment:6 by Natalia Bidart, 8 months ago

Triage Stage: Unreviewed → Accepted

Replying to $ῗἧḡḥ𝐀丂𝓱м𝑒𝑒𝐓:

Hello, please read the contributing docs that state that a reporter can't accept their own ticket.

I have looked into the proposed changes and I agree we could apply some of the cleanups, in main only. Accepting on that basis, but the PR needs work in that:

  • remove the changes where hyphens are added
  • ensure proper line wrapping, again please follow the contributing guide to the letter
  • the AI disclosure option is checked but there is no information on which and how the AI was used.

comment:7 by Natalia Bidart, 8 months ago

Resolution: invalid
Status: closed → new

comment:8 by Natalia Bidart, 8 months ago

Owner: set to $ῗἧḡḥ𝐀丂𝓱м𝑒𝑒𝐓
Patch needs improvement: set
Status: new → assigned

comment:9 by Natalia Bidart, 8 months ago

Patch needs improvement: unset
Triage Stage: Accepted → Ready for checkin

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

Resolution: → fixed
Status: assigned → closed

In fb3a110:

Fixed #36918 -- Removed double spaces and fixed minor grammar issues in docs.

Co-authored-by: Clifford Gama <cliffygamy@…>

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