#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 , 15 years ago
Triage Stage: | Unreviewed → Accepted |
---|
comment:2 by , 14 years ago
Summary: | http://docs.djangoproject.com/en/dev/howto/initial-data/ lies ;-) → Serialization docs lack information on specific formats |
---|
comment:3 by , 14 years ago
Severity: | → Normal |
---|---|
Type: | → Bug |
comment:4 by , 13 years ago
UI/UX: | unset |
---|
comment:6 by , 12 years ago
Owner: | changed from | to
---|---|
Status: | new → assigned |
comment:7 by , 12 years ago
Would a documented example for each format be sufficient here? Esp. for XML there should also be an XSD.
comment:8 by , 12 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 , 12 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 , 12 years ago
Resolution: | → fixed |
---|---|
Status: | assigned → closed |
comment:11 by , 12 years ago
Keywords: | sprint2013 added |
---|
Change UI/UX from NULL to False.