Gregory Szorc <gregory.szorc@gmail.com> [Mon, 09 Feb 2015 23:07:39 -0800] rev 24099
help.merge-tools: do not double document merge tools
Merge tools were being double documented in help system output due
to functions being defined under multiple names in the merge tools
dictionary.
Establish a new dictionary for just the tools to document and
use it from the help system so we don't get double output.
Double documentation likely plagues other auto-documented items
as well. It might be a good idea to eventually compare function
instances to filter out duplicate entries from dictionaries
passed to ``makeitemsdoc``. However, without an easy way to break
ties, this may result in some functions being advertised over
their modern equivalents. This would be a noble patch series.
But it isn't one this author is willing to tackle at this time.
Gregory Szorc <gregory.szorc@gmail.com> [Mon, 09 Feb 2015 14:59:04 -0800] rev 24098
help: teach topic symbols how to dedent
When using docstrings for documenting symbols such as revsets,
templates, or hgweb commands, documentation likely has leading
whitespace corresponding to the indentation from the Python source
file.
Up until this point, the help system stripped all leading and
trailing whitespace and replaced it with 2 spaces of leading
whitespace. There were a few bad side-effects. First, sections
could not be used in docstrings because they would be indented
and the rst parser would fail to parse them as sections. Also,
any rst elements that required indentation would lose their
indentation, again causing them to be parsed and rendered
incorrectly.
In this patch, we teach the topic symbols system how to dedent
text properly. I argue this mode should be enabled by default.
However, I stopped short of changing that because it would cause
a lot of documentation reformatting to occur. I'm not sure if
people are relying on or wanting indentation. So, dedenting has
only been turned on for hgweb symbols. This decision should be
scrutinized.
Gregory Szorc <gregory.szorc@gmail.com> [Fri, 06 Feb 2015 22:25:40 -0800] rev 24097
webcommands: document "graph" web command
Gregory Szorc <gregory.szorc@gmail.com> [Fri, 06 Feb 2015 22:19:59 -0800] rev 24096
webcommands: document "archive" web command
Gregory Szorc <gregory.szorc@gmail.com> [Fri, 06 Feb 2015 22:11:54 -0800] rev 24095
webcommands: document "filelog" web command
Gregory Szorc <gregory.szorc@gmail.com> [Fri, 06 Feb 2015 22:08:30 -0800] rev 24094
webcommands: document "annotate" web command