( )⚙ D5186 help: when replacing placeholders in help files, insert indented text

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5186

help: when replacing placeholders in help files, insert indented text
AbandonedPublic

Authored by valentin.gatienbaron on Oct 23 2018, 3:28 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Summary

So one can add text without hardcoding the indentation it will need.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

yuja added a subscriber: yuja.Oct 24 2018, 7:45 AM
  • a/mercurial/help.py

+++ b/mercurial/help.py
@@ -391,6 +391,12 @@

single documentation block and use it to overwrite the marker in doc.
"""
entries = []

+ markerindent = 0
+ markerpos = doc.find(marker)
+ if markerpos >= 0:
+ newlinepos = doc.rfind('\n', 0, markerpos)
+ if newlinepos >= 0:
+ markerindent = markerpos - newlinepos - 1

Perhaps, it's simpler to use re.sub() instead of doc.replace(...), something
like:

markerre = re.compile(br'^(\s*)%s' % re.escape(marker), re.MULTILINE)
markerre.sub(builditemsdoc, doc)

Revision Contents
Changeset List

PathPackages
Mmercurial/help.py (8 lines)
Mmercurial/help/hgweb.txt (2 lines)

Diff 12330

mercurial/help.py

def addtopichook(topic, rewriter): def addtopichook(topic, rewriter):
helphooks.setdefault(topic, []).append(rewriter) helphooks.setdefault(topic, []).append(rewriter)
def makeitemsdoc(ui, topic, doc, marker, items, dedent=False): def makeitemsdoc(ui, topic, doc, marker, items, dedent=False):
"""Extract docstring from the items key to function mapping, build a """Extract docstring from the items key to function mapping, build a
single documentation block and use it to overwrite the marker in doc. single documentation block and use it to overwrite the marker in doc.
""" """
entries = [] entries = []
markerindent = 0
markerpos = doc.find(marker)
if markerpos >= 0:
newlinepos = doc.rfind('\n', 0, markerpos)
if newlinepos >= 0:
markerindent = markerpos - newlinepos - 1
for name in sorted(items): for name in sorted(items):
text = (pycompat.getdoc(items[name]) or '').rstrip() text = (pycompat.getdoc(items[name]) or '').rstrip()
if (not text if (not text
or not ui.verbose and any(w in text for w in _exclkeywords)): or not ui.verbose and any(w in text for w in _exclkeywords)):
continue continue
text = gettext(text) text = gettext(text)
if dedent: if dedent:
# Abuse latin1 to use textwrap.dedent() on bytes. # Abuse latin1 to use textwrap.dedent() on bytes.
text = textwrap.dedent(text.decode('latin1')).encode('latin1') text = textwrap.dedent(text.decode('latin1')).encode('latin1')
lines = text.splitlines() lines = text.splitlines()
doclines = [(lines[0])] doclines = [(lines[0])]
for l in lines[1:]: for l in lines[1:]:
# Stop once we find some Python doctest # Stop once we find some Python doctest
if l.strip().startswith('>>>'): if l.strip().startswith('>>>'):
break break
if dedent: if dedent:
doclines.append(l.rstrip()) doclines.append(markerindent * ' ' + l.rstrip())
else: else:
doclines.append(' ' + l.strip()) doclines.append(' ' + l.strip())
entries.append('\n'.join(doclines)) entries.append('\n'.join(doclines))
entries = '\n\n'.join(entries) entries = '\n\n'.join(entries)
return doc.replace(marker, entries) return doc.replace(marker, entries)
def addtopicsymbols(topic, marker, symbols, dedent=False): def addtopicsymbols(topic, marker, symbols, dedent=False):
def add(ui, topic, doc): def add(ui, topic, doc):

mercurial/help/hgweb.txt

revision identifier. However, any value described by revision identifier. However, any value described by
:hg:`help revisions` typically works. :hg:`help revisions` typically works.
Commands and URLs Commands and URLs
================= =================
The following web commands and their URLs are available: The following web commands and their URLs are available:
.. webcommandsmarker .. webcommandsmarker