Patchwork D9990: gendoc: use an empty comment so aliases are separated from previous elements

login
register
mail settings
Submitter phabricator
Date Feb. 12, 2021, 9:31 p.m.
Message ID <differential-rev-PHID-DREV-6qrybuuozjg5irxe5dha-req@mercurial-scm.org>
Download mbox | patch
Permalink /patch/48305/
State Superseded
Headers show

Comments

phabricator - Feb. 12, 2021, 9:31 p.m.
spectral created this revision.
Herald added a reviewer: hg-reviewers.
Herald added a subscriber: mercurial-patches.

REVISION SUMMARY
  For commands like `hg bookmarks`, where there's no `[+] marked option can be
  specified multiple times`, this causes the final option in the option list to
  not be the parent of the aliases definition. The aliases section is thus marked
  as a blockquote like on commands that do have text separating the option list
  and the aliases definition.

REPOSITORY
  rHG Mercurial

BRANCH
  default

REVISION DETAIL
  https://phab.mercurial-scm.org/D9990

AFFECTED FILES
  doc/gendoc.py

CHANGE DETAILS




To: spectral, #hg-reviewers
Cc: mercurial-patches, mercurial-devel

Patch

diff --git a/doc/gendoc.py b/doc/gendoc.py
--- a/doc/gendoc.py
+++ b/doc/gendoc.py
@@ -317,7 +317,11 @@ 
                 ui.write(b"\n")
             # aliases
             if d[b'aliases']:
-                ui.write(_(b"    aliases: %s\n\n") % b" ".join(d[b'aliases']))
+                # Note the empty comment, this is required to separate this
+                # (which should be a blockquote) from any preceding things (such
+                # as a definition list).
+                ui.write(_(b"..\n\n    aliases: %s\n\n") %
+                         b" ".join(d[b'aliases']))
 
 
 def allextensionnames():