Mercurial > hg-stable

changeset 24081:ff42de48193c

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
webcommands: document "help" web command
author Gregory Szorc <gregory.szorc@gmail.com>
date Fri, 06 Feb 2015 20:41:08 -0800
parents a3f2ea1d4943
children 32dabf811b39
files mercurial/hgweb/webcommands.py
diffstat 1 files changed, 13 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/mercurial/hgweb/webcommands.py	Fri Feb 06 20:27:56 2015 -0800
+++ b/mercurial/hgweb/webcommands.py	Fri Feb 06 20:41:08 2015 -0800
@@ -1081,6 +1081,19 @@
 
 @webcommand('help')
 def help(web, req, tmpl):
+    """
+    /help[/{topic}]
+    ---------------
+
+    Render help documentation.
+
+    This web command is roughly equivalent to :hg:`help`. If a ``topic``
+    is defined, that help topic will be rendered. If not, an index of
+    available help topics will be rendered.
+
+    The ``help`` template will be rendered when requesting help for a topic.
+    ``helptopics`` will be rendered for the index of help topics.
+    """
     from mercurial import commands # avoid cycle
     from mercurial import help as helpmod # avoid cycle