Work at SourceForge, help us to make it a better place! We have an immediate need for a Support Technician in our San Francisco or Denver office.

Close

#226 Really long docstrings get truncated in PDF output

v3.0
closed-fixed
Edward Loper
4
2008-02-25
2007-09-23
No

This is an extension of bug #1750929, which I just closed. It uses the same example code, except with the docstring marked as a raw string with r""".

The docstring for encodePath() is really long. In the PDF output, it doesn't fit on one page. The description is truncated (and smushed into the bottom of the page). The arguments and notes don't appear at all.

Discussion

  • Code that demonstrates bug

     
    Attachments
  • Resulting PDF showing truncated output

     
    Attachments
  • Logged In: YES
    user_id=1168720
    Originator: YES

    File Added: api.pdf

     
  • Logged In: YES
    user_id=1168720
    Originator: YES

    I should mention that the same thing happens in the Postscript output.

     
  • Edward Loper
    Edward Loper
    2007-09-23

    • priority: 5 --> 4
     
  • Edward Loper
    Edward Loper
    2007-09-23

    Logged In: YES
    user_id=195958
    Originator: NO

    Yeah, this isn't too surprising, given the latex I'm generating as output -- I put each function's description in a 'boxedminipage' environment, and these won't happily span pages. One option would be to remove the boxes, and just eg indent the contents. I sort of like the look of the boxes in the output, though. Any latex wizards out there want to suggest a good way to do this?

    Alternatively, if anyone wants to mock up some latex output that looks better than the current output, I could try to adapt docwriter/latex.py to generate that kind of output.

    It looks like there's a related bug for properties & variables with very long docstrings, since the latex longtable environment doesn't seem to be able to handle single cells that are larger than one page.

    I'm not all that attached to the current latex output, so as I said, if anyone wants to mock up some better output, have at it. :)

     
  • Edward Loper
    Edward Loper
    2008-02-25

    Logged In: YES
    user_id=195958
    Originator: NO

    The latest version of epydoc now uses latex style files (*.sty) to control epydoc's output. Although this problem still affects the default output style, it is now possible to avoid by either defining your own style, or by using the "epydoc-base" style (call epydoc with "--sty base"). Of course, if you just use the 'epydoc-base' style, your output looks fairly spartan. Hopefully, someone will come up with a .sty file that gives nice looking output but still wraps over pages well.

    I'm going to go ahead and close this bug now -- it's about as fixed as it's likely to get. :) Although if any latex wizards want to tell me how to replace a (boxed)minipage with something that acts the same, but can wrap over pages, I would appreciate it.

     
  • Edward Loper
    Edward Loper
    2008-02-25

    • status: open --> closed-fixed