[Lldb-commits] [lldb] r156018 - /lldb/trunk/www/python-reference.html

[Enrico Granata]

Author: enrico
Date: Wed May  2 16:00:41 2012
New Revision: 156018

URL: http://llvm.org/viewvc/llvm-project?rev=156018&view=rev
Log:
Mentioning in the docs that Python commands can have docstrings

Modified:
    lldb/trunk/www/python-reference.html

Modified: lldb/trunk/www/python-reference.html
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/www/python-reference.html?rev=156018&r1=156017&r2=156018&view=diff
==============================================================================
--- lldb/trunk/www/python-reference.html (original)
+++ lldb/trunk/www/python-reference.html Wed May  2 16:00:41 2012
@@ -255,6 +255,13 @@
         <code><pre><tt>def command_function(<b>debugger</b>, <b>command</b>, <b>result</b>, <b>dict</b>):
           <font color=green># Your code goes here</font>
         </tt></pre></code>
+
+		Optionally, you can also provide a Python docstring, and LLDB will use it when providing help for your command, as in:
+        <code><pre><tt>def command_function(<b>debugger</b>, <b>command</b>, <b>result</b>, <b>dict</b>):
+          <font color=green>"""This command takes a lot of options and does many fancy things"""</font>    
+          <font color=green># Your code goes here</font>
+        </tt></pre></code>
+
         <p><table class="stats" width="620" cellspacing="0">
         <tr>
             <td class="hed" width="10%">Argument</td>