Code

Opened 5 years ago

Closed 5 years ago

#10218 closed (fixed)

Unnecessary quotes in serialization documentation

Reported by: thedaniel Owned by: nobody
Component: Documentation Version: 1.0
Severity: Keywords:
Cc: Triage Stage: Unreviewed
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: UI/UX:

Description

The serialization docs say:

Django "ships" with a few included serializers:

The quotes imply Django either a) doesn't ship (the stigma of which we've hopefully escaped by releasing 1.0) or b) that this usage of "ship" is a self-conscious use of vernacular. As this use of "to ship" is common in the software world, and we do actually ship, the quotes are not necessary. Patch attached.

Attachments (1)

no-quotes.diff (479 bytes) - added by thedaniel 5 years ago.
no quotes!

Download all attachments as: .zip

Change History (3)

Changed 5 years ago by thedaniel

no quotes!

comment:1 Changed 5 years ago by ubernostrum

  • Needs documentation unset
  • Needs tests unset
  • Patch needs improvement unset

I could be wrong, but I believe part of the reason for this is that the serializers themselves are only part of the equation: some of them require third-party Python modules before they actually work. Therefore Django "ships" the serializer, but you may still need other software before you can use it in practice (and the modules you'll need are documented).

comment:2 Changed 5 years ago by adrian

  • Resolution set to fixed
  • Status changed from new to closed

(In [9850]) Fixed #10218 -- Reworded serialization.txt sentence to remove awkward quotes. Thanks for bringing this up, thedaniel

Add Comment

Modify Ticket

Change Properties
<Author field>
Action
as closed
as The resolution will be set. Next status will be 'closed'
The resolution will be deleted. Next status will be 'new'
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.