Edgewall Software

Opened 16 years ago

Closed 15 years ago

#304 closed enhancement (wontfix)

Update documentation for Stream class

Reported by: alex.slesarev@… Owned by: cmlenz
Priority: trivial Milestone: 0.6
Component: Documentation Version: devel
Keywords: Cc:

Description

Please update documentation for render method (for example, in note section): it accepts strip_whitespace parameter (via kwargs), and in certain cases it is critical that whitespaces are not being stripped during rendering.

Unfortunately, now it is too difficult to find that this parameter even exists.

Change History (2)

comment:1 Changed 15 years ago by jruigrok

Generating the documentation via epydoc (python setup.py build_doc) does provide all the relevant documentation.

However, the documentation on the site for the generated API documentation uses a macro script, which has a few bugs and does not grab the full docstring from init() in some of the classes.

comment:2 Changed 15 years ago by cmlenz

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

This information is in fact included on the documentation page on streams, see:

Serialization Options

Also, the docstring of Stream.render() says that “Any additional keyword arguments are passed to the serializer, and thus depend on the method parameter value.” The serializers in turn document the strip_whitespace option.

I could duplicate this information all over the place, but I'd rather not :P

Note: See TracTickets for help on using tickets.