Opened 14 years ago

Closed 11 years ago

Last modified 11 years ago

#11971 closed Bug (fixed)

Serialization docs lack information on specific formats

Reported by: chrisw Owned by: Horst Gutmann
Component: Documentation Version: 1.1
Severity: Normal Keywords: sprint2013
Cc: Triage Stage: Accepted
Has patch: yes Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description

This paragraph:

http://docs.djangoproject.com/en/dev/howto/initial-data/#providing-initial-data-with-fixtures

...promises that the serialization docs will give an explanation of the serialisation formats. They don't. In fact the initial-data docs come closest to doing this with the JSON and YAML examples, but nothing for the XML.

So, the bug is that the promise should be fulfilled and the actual formats should be documented somewhere in:

http://docs.djangoproject.com/en/dev/topics/serialization/#id1

For example, what brought me to this:

  • How do I do a datetime in JSON?
  • What's the schema for the XML import? How do I do different field types with it?

cheers,

Chris

Change History (11)

comment:1 by Russell Keith-Magee, 14 years ago

Triage Stage: UnreviewedAccepted

comment:2 by Gabriel Hurley, 13 years ago

Summary: http://docs.djangoproject.com/en/dev/howto/initial-data/ lies ;-)Serialization docs lack information on specific formats

comment:3 by Julien Phalip, 13 years ago

Severity: Normal
Type: Bug

comment:4 by Aymeric Augustin, 12 years ago

UI/UX: unset

Change UI/UX from NULL to False.

comment:5 by Aymeric Augustin, 12 years ago

Easy pickings: unset

Change Easy pickings from NULL to False.

comment:6 by Horst Gutmann, 11 years ago

Owner: changed from nobody to Horst Gutmann
Status: newassigned

comment:7 by Horst Gutmann, 11 years ago

Would a documented example for each format be sufficient here? Esp. for XML there should also be an XSD.

comment:8 by Horst Gutmann, 11 years ago

A first draft can be found here: https://github.com/zerok/django/commits/tickets/11971

Would this be detailed enough?

comment:9 by Horst Gutmann, 11 years ago

Has patch: set

I converted this into a pull request be better readability: https://github.com/django/django/pull/815

comment:10 by Aymeric Augustin <aymeric.augustin@…>, 11 years ago

Resolution: fixed
Status: assignedclosed

In b6aede326803bfdf18f932ec2fa8b9304467d29f:

Merge pull request #815 from zerok/tickets/11971

Fixed #11971 -- Documented the serialization formats

comment:11 by Horst Gutmann, 11 years ago

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