Mentioning in the docs that Python commands can have docstrings
git-svn-id: https://llvm.org/svn/llvm-project/lldb/trunk@156018 91177308-0d34-0410-b5e6-96231b3b80d8
diff --git a/www/python-reference.html b/www/python-reference.html
index 4c2bc5c..6381f0d 100755
--- a/www/python-reference.html
+++ b/www/python-reference.html
@@ -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>