# HG changeset patch # User Gregory Szorc # Date 1423284068 28800 # Node ID ff42de48193c734d690dfb7657d4c155d0320f86 # Parent a3f2ea1d49434ef5cdb124aa8bb6808129b414e6 webcommands: document "help" web command diff -r a3f2ea1d4943 -r ff42de48193c mercurial/hgweb/webcommands.py --- 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