#250 Function @return description cut on the "word" 'i.e.'

closed-works-for-me
5
2008-02-16
2008-02-01
No

Hi, it's me again!

Just trying to find out if the bug is again between the keyboard I'm typing on and the chair I'm sitting on.

I'm on Win XP using the command line version of epydoc 3.0.

I have the following simple attempt to use epydoc (indentation differs a little here due to space restrictions):

def page_word(page, word, href):
'''
@param page: The currently active HTML page
@type page: str
@param word: The currently active word
@type word: str
@param href: The hypertext reference to be
solved
@type href: str
@return: A tuple (page,word), where page is the
new current HTML page to be sent to
the client browser and word is the
new current word
@rtype: A tuple (str,str)
'''

The result is sort of what I expected with my little epydoc experience. I have not attached a file of this successful attempt.

If I then change the @return description just a little by inserting 'i.e.' between the words 'client' and 'browser' the result is what I have attached to this post.

There you can see that the @return description is cut on 'i.e.' in the upper part of the page but not at the bottom.

Should I use some kind of markup on 'i.e.' or what?

Jussi

Discussion

  • Anonymous - 2008-02-01
     
  • Anonymous - 2008-02-01

    Logged In: YES
    user_id=1832091
    Originator: YES

    File Added: index.html

     
  • Anonymous - 2008-02-01

    This is harder than I expected. Hopefully this is the correct page.

     
  • Anonymous - 2008-02-01

    Logged In: YES
    user_id=1832091
    Originator: YES

    File Added: browserver-module.html

     
  • Edward Loper

    Edward Loper - 2008-02-02
    • status: open --> pending-works-for-me
     
  • Edward Loper

    Edward Loper - 2008-02-02

    Logged In: YES
    user_id=195958
    Originator: NO

    This is an unfortunate side effect of the way that epydoc currently generates summary of your docstring for inclusion in the index table -- namely, with the following regexp that looks for a period at the end of a word:

    r'(\s*[\w\W]*?\.)(\s|$)'

    One hackish workaround is to enclose the "i.e" in some sort of markup. In epydoc, you could put it in italics like this: "I{i.e.}". In restructuredtext, it would be "*i.e.*".

    Another workaround is to use the "@summary:" field, which allows you to override the automatic summary extraction, and directly tell epydoc what you want the summary to be.

    If you have any suggestions for other ways to do this cleanly, I'd be happy to hear them. :)

     
  • SourceForge Robot

    Logged In: YES
    user_id=1312539
    Originator: NO

    This Tracker item was closed automatically by the system. It was
    previously set to a Pending status, and the original submitter
    did not respond within 14 days (the time period specified by
    the administrator of this Tracker).

     
  • SourceForge Robot

    • status: pending-works-for-me --> closed-works-for-me
     

Log in to post a comment.

Get latest updates about Open Source Projects, Conferences and News.

Sign up for the SourceForge newsletter:





No, thanks