epydoc-devel

[Epydoc-devel] Wrapping ling lines in source snippets

[Torsten B. <br...@ph...>]

Hallöchen!

I use doctests and so I have long lines in my docstrings sometimes,
e.g.

    >>> setting = Setting("key", "value")
    >>> setting.set_value("Hallo")
    >>> setting.value
    u'Hallo'
    >>> setting.set_value(1)
    Traceback (most recent call last):
      ...
    SettingWrongTypeError: setting 'key = 1': new value of type 'int' is unequal to previous type 'unicode'

Unfortunately, this spoils the HTML frame because it forces a
horizontal scrollbar.  Is it possible to break this somehow?

Tschö,
Torsten.

-- 
Torsten Bronger, aquisgrana, europa vetus
                                      Jabber ID: br...@ja...
               (See http://ime.webhop.org for further contact info.)

Re: [Epydoc-devel] Wrapping ling lines in source snippets

[Edward L. <ed...@se...>]

>  I use doctests and so I have long lines in my docstrings sometimes,
>  [...]
>  Unfortunately, this spoils the HTML frame because it forces a
>  horizontal scrollbar.  Is it possible to break this somehow?

If you don't plan to use doctest to test the code, then you could just
wrap the line in your source file.  I.e.:

>     >>> setting.set_value(1)
>     Traceback (most recent call last):
>       ...
>     SettingWrongTypeError: setting 'key = 1': new value
>     of type 'int' is unequal to previous type 'unicode'

If you do plan to use doctest to test the code, then you could still
wrap the line, but you'd need to use a directive -- either
doctest:+NORMALIZE_WHITESPACE or doctest:+IGNORE_EXCEPTION_DETAIL; see
the documentation for doctest [1] for details.  E.g.:

>     >>> setting.set_value(1)  # doctest: +NORMALIZE_WHITESPACE
>     Traceback (most recent call last):
>       ...
>     SettingWrongTypeError: setting 'key = 1': new value
>     of type 'int' is unequal to previous type 'unicode'

-Edward

[1] http://docs.python.org/lib/module-doctest.html