[Epydoc-commits] SF.net SVN: epydoc: [1737] trunk/epydoc/src/epydoc/markup/__init__.py

[<ed...@us...>]

Revision: 1737
          http://epydoc.svn.sourceforge.net/epydoc/?rev=1737&view=rev
Author:   edloper
Date:     2008-02-22 17:07:47 -0800 (Fri, 22 Feb 2008)

Log Message:
-----------
Clarified a docstring

Modified Paths:
--------------
    trunk/epydoc/src/epydoc/markup/__init__.py

Modified: trunk/epydoc/src/epydoc/markup/__init__.py
===================================================================
--- trunk/epydoc/src/epydoc/markup/__init__.py	2008-02-23 01:07:30 UTC (rev 1736)
+++ trunk/epydoc/src/epydoc/markup/__init__.py	2008-02-23 01:07:47 UTC (rev 1737)
@@ -466,7 +466,9 @@
             should be linked to.
         @type label: C{string} or C{None}
         @param label: The label that should be used for the identifier,
-            if it's different from the name of the identifier.
+            if it's different from the name of the identifier.  This
+            should be expressed in the target markup language -- e.g.
+            for latex, "_"s should be escaped.
         @rtype: C{string}
         @return: The translated crossreference link.
         """


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.