sphinx-contrib / pecanwsme

Extension to Sphinx for documenting APIs built with Pecan and WSME
Other
5 stars 12 forks source link

single line doc strings generate malformed documents #8

Open AevaOnline opened 10 years ago

AevaOnline commented 10 years ago

A single line python doc string, eg:

class FooController:
  @wsme_pecan.wsexpose(Foo, wtype.text)
  def get(self, param):
    """some docstring here"""

will cause this extension to generate malformed .rst documentation, which will look something like this:

GET /foo/
  some docstring here. :type param: text

Simply converting the doc string to multi-line solves the problem. Of course, adding a proper doc string for each parameter is good, but the formatting shouldn't be broken without this.