Patchwork help: explain how to access subtopics in internals

login
register
mail settings
Submitter via Mercurial-devel
Date April 25, 2017, 10:52 p.m.
Message ID <5b47b4bcd79cae50890f.1493160767@matvore-linux.svl.corp.google.com>
Download mbox | patch
Permalink /patch/20298/
State Superseded
Headers show

Comments

via Mercurial-devel - April 25, 2017, 10:52 p.m.
# HG changeset patch
# User Matt DeVore <matvore@google.com>
# Date 1492646662 25200
#      Wed Apr 19 17:04:22 2017 -0700
# Node ID 5b47b4bcd79cae50890fb2973084111614a8bd0f
# Parent  ed42e00a5c4ec7a3bebaec699ef934429cdc2ddd
help: explain how to access subtopics in internals
Sean Farley - April 25, 2017, 11:32 p.m.
Matt DeVore via Mercurial-devel <mercurial-devel@mercurial-scm.org>
writes:

> # HG changeset patch
> # User Matt DeVore <matvore@google.com>
> # Date 1492646662 25200
> #      Wed Apr 19 17:04:22 2017 -0700
> # Node ID 5b47b4bcd79cae50890fb2973084111614a8bd0f
> # Parent  ed42e00a5c4ec7a3bebaec699ef934429cdc2ddd
> help: explain how to access subtopics in internals

Sure, looks good to me.
Sean Farley - April 25, 2017, 11:34 p.m.
Sean Farley <sean@farley.io> writes:

> Matt DeVore via Mercurial-devel <mercurial-devel@mercurial-scm.org>
> writes:
>
>> # HG changeset patch
>> # User Matt DeVore <matvore@google.com>
>> # Date 1492646662 25200
>> #      Wed Apr 19 17:04:22 2017 -0700
>> # Node ID 5b47b4bcd79cae50890fb2973084111614a8bd0f
>> # Parent  ed42e00a5c4ec7a3bebaec699ef934429cdc2ddd
>> help: explain how to access subtopics in internals
>
> Sure, looks good to me.

I should add: I'm a little surprised this doesn't change any tests?
Also, since we're in a freeze, patches should be flagged as stable: hg
email --flag STABLE, fyi
Sean Farley - April 25, 2017, 11:36 p.m.
Sean Farley <sean@farley.io> writes:

> Sean Farley <sean@farley.io> writes:
>
>> Matt DeVore via Mercurial-devel <mercurial-devel@mercurial-scm.org>
>> writes:
>>
>>> # HG changeset patch
>>> # User Matt DeVore <matvore@google.com>
>>> # Date 1492646662 25200
>>> #      Wed Apr 19 17:04:22 2017 -0700
>>> # Node ID 5b47b4bcd79cae50890fb2973084111614a8bd0f
>>> # Parent  ed42e00a5c4ec7a3bebaec699ef934429cdc2ddd
>>> help: explain how to access subtopics in internals
>>
>> Sure, looks good to me.
>
> I should add: I'm a little surprised this doesn't change any tests?
> Also, since we're in a freeze, patches should be flagged as stable: hg
> email --flag STABLE, fyi

(argh, keep sending too quickly) Doc fixes are always welcomed (even
during the freeze) :-)

Patch

diff -r ed42e00a5c4e -r 5b47b4bcd79c mercurial/help.py
--- a/mercurial/help.py	Thu Apr 13 22:31:17 2017 +0900
+++ b/mercurial/help.py	Wed Apr 19 17:04:22 2017 -0700
@@ -203,7 +203,8 @@ 
 
 def internalshelp(ui):
     """Generate the index for the "internals" topic."""
-    lines = []
+    lines = ['To access a subtopic, use "hg help internals.{subtopic-name}"\n',
+             '\n']
     for names, header, doc in internalstable:
         lines.append(' :%s: %s\n' % (names[0], header))