[docs] [issue9767] Failures in json doc examples
Terry J. Reedy
report at bugs.python.org
Fri Sep 3 23:32:52 CEST 2010
New submission from Terry J. Reedy <tjreedy at udel.edu>:
I ran doctest on LibRef 17.2 json saved as .txt. There are 4 failures: 2 are clearly doc issues, the other 2 I do not know. I hope someone reads this who is already familiar
DOC PATCHES
dumps(2 + 1j, cls=ComplexEncoder)
should be
json.dumps(2 + 1j, cls=ComplexEncoder)
and
JSONEncoder().encode({"foo": ["bar", "baz"]})
should be
json.JSONEncoder().encode({"foo": ["bar", "baz"]})
Needing similar additions in example code (not caught by doctest) are
return JSONEncoder.default(self, o)
for chunk in JSONEncoder().iterencode(bigobject):
Those fixes leave 2 failures I an unclear about and hope a json expert will comment on.
1.'''
Failed example:
print(json.dumps({'4': 5, '6': 7}, sort_keys=True, indent=4))
Expected:
{
"4": 5,
"6": 7
}
Got:
{
"4": 5,
"6": 7
}
'''
The difference is that json puts a trailing space after '5,'. Should it? or should one be added to the doc?
2. '''
Failed example:
list(ComplexEncoder().iterencode(2 + 1j))
Expected:
['[', '2.0', ', ', '1.0', ']']
Got:
['[2.0', ', 1.0', ']']
'''
Without knowing how the default iterencode interacts with the overwridden .default() method, I have no idea.
----------
assignee: docs at python
components: Documentation, Library (Lib)
messages: 115512
nosy: docs at python, terry.reedy
priority: normal
severity: normal
status: open
title: Failures in json doc examples
type: behavior
_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue9767>
_______________________________________
More information about the docs
mailing list