Package: python-epydoc
Version: 3.0.1-1
Severity: wishlist


It's really nice to be able to put a comment on
a global variable with the #: operator.   I find
it much less distracting than the alternative, which is
to have lots of strings floating around in the code.

However, it seems to be limited to one line comments
and that's too short.   Please extend it to allow multi-line
comments.

#: One gets into situations where you have a lot to say about a variable and 
the description text just wraps and wraps and wraps and makes your python code 
look ugly.
SomeVariable = 'ugly'

#: It would be very nice if all the #: lines
#: that were immediately before a variable were
#: collected into one block of text.   Then,
#: you could write fairly clean descriptions.
SomeOtherVariable = 'elegant'

"""Of course, you can do it with triple-quoted strings,
but I find that these look too much like actual code
that can get executed.   It's nice to have the hash
mark at the beginning of each line to remind you that
this is a comment and has no effect on the execution of
the program."""
AThirdVariable = 'Not visually distinct.'

-- System Information:
Debian Release: lenny/sid
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: i386 (i686)

Kernel: Linux 2.6.22-3-686 (SMP w/1 CPU core)
Locale: LANG=en_GB, LC_CTYPE=en_GB (charmap=ISO-8859-1)
Shell: /bin/sh linked to /bin/bash

Versions of packages python-epydoc depends on:
ii  python                        2.4.4-6    An interactive high-level object-o
ii  python-support                0.7.6      automated rebuilding support for p

Versions of packages python-epydoc recommends:
ii  graphviz                   2.16-3        rich set of graph drawing tools
ii  gs-common                  0.3.13-0.1    Common files for different Ghostsc
ii  python-docutils            0.4-5         Utilities for the documentation of
ii  python-tk                  2.4.4-3       Tkinter - Writing Tk applications 
ii  texlive-fonts-recommended  2007-13       TeX Live: Recommended fonts
ii  texlive-latex-base         2007-13       TeX Live: Basic LaTeX packages
ii  texlive-latex-extra        2007.dfsg.1-1 TeX Live: LaTeX supplementary pack
ii  texlive-latex-recommended  2007-13       TeX Live: LaTeX recommended packag

-- no debconf information



-- 
To UNSUBSCRIBE, email to [EMAIL PROTECTED]
with a subject of "unsubscribe". Trouble? Contact [EMAIL PROTECTED]

Reply via email to