Opened 7 years ago

Closed 4 years ago

Last modified 4 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 Changed 7 years ago by Russell Keith-Magee

Triage Stage: UnreviewedAccepted

comment:2 Changed 6 years ago by Gabriel Hurley

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

comment:3 Changed 6 years ago by Julien Phalip

Severity: Normal
Type: Bug

comment:4 Changed 5 years ago by Aymeric Augustin

UI/UX: unset

Change UI/UX from NULL to False.

comment:5 Changed 5 years ago by Aymeric Augustin

Easy pickings: unset

Change Easy pickings from NULL to False.

comment:6 Changed 4 years ago by Horst Gutmann

Owner: changed from nobody to Horst Gutmann
Status: newassigned

comment:7 Changed 4 years ago by Horst Gutmann

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

comment:8 Changed 4 years ago by Horst Gutmann

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

Would this be detailed enough?

comment:9 Changed 4 years ago by Horst Gutmann

Has patch: set

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

comment:10 Changed 4 years ago by Aymeric Augustin <aymeric.augustin@…>

Resolution: fixed
Status: assignedclosed

In b6aede326803bfdf18f932ec2fa8b9304467d29f:

Merge pull request #815 from zerok/tickets/11971

Fixed #11971 -- Documented the serialization formats

comment:11 Changed 4 years ago by Horst Gutmann

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