Patchwork help: format ``commands`` heading correctly

login
register
mail settings
Submitter via Mercurial-devel
Date March 22, 2017, 11:37 p.m.
Message ID <cd99f61579194767aaa9.1490225856@martinvonz.mtv.corp.google.com>
Download mbox | patch
Permalink /patch/19597/
State Accepted
Headers show

Comments

via Mercurial-devel - March 22, 2017, 11:37 p.m.
# HG changeset patch
# User Martin von Zweigbergk <martinvonz@google.com>
# Date 1490225813 25200
#      Wed Mar 22 16:36:53 2017 -0700
# Node ID cd99f61579194767aaa958a29d8de88e639d1578
# Parent  55c6788c54e2faf80ec14f2b0844bfe429012bc3
help: format ``commands`` heading correctly

The number of dashes under it needs to match exactly for it to be
rendered as a heading. Without this change, the dashes end up on the
same line as "commands", and "hg help config.commands" does not work.
Ryan McElroy - March 23, 2017, 10:14 a.m.
On 3/22/17 11:37 PM, Martin von Zweigbergk via Mercurial-devel wrote:
> # HG changeset patch
> # User Martin von Zweigbergk <martinvonz@google.com>
> # Date 1490225813 25200
> #      Wed Mar 22 16:36:53 2017 -0700
> # Node ID cd99f61579194767aaa958a29d8de88e639d1578
> # Parent  55c6788c54e2faf80ec14f2b0844bfe429012bc3
> help: format ``commands`` heading correctly
Kostia also send this patch out (see 
https://patchwork.mercurial-scm.org/patch/19579/), and either one will 
work fine. Let's just get one of them in.

Sorry for breaking this when I renamed the section. I should probably 
add a check-code for this as penance.

>
> The number of dashes under it needs to match exactly for it to be
> rendered as a heading. Without this change, the dashes end up on the
> same line as "commands", and "hg help config.commands" does not work.
>
> diff -r 55c6788c54e2 -r cd99f6157919 mercurial/help/config.txt
> --- a/mercurial/help/config.txt	Tue Mar 21 22:47:49 2017 -0700
> +++ b/mercurial/help/config.txt	Wed Mar 22 16:36:53 2017 -0700
> @@ -415,7 +415,7 @@
>       extension).
>   
>   ``commands``
> -----------
> +------------
>   
>   ``update.requiredest``
>       Require that the user pass a destination when running ``hg update``.
>
Augie Fackler - March 23, 2017, 3:33 p.m.
On Thu, Mar 23, 2017 at 10:14:12AM +0000, Ryan McElroy wrote:
> On 3/22/17 11:37 PM, Martin von Zweigbergk via Mercurial-devel wrote:
> ># HG changeset patch
> ># User Martin von Zweigbergk <martinvonz@google.com>
> ># Date 1490225813 25200
> >#      Wed Mar 22 16:36:53 2017 -0700
> ># Node ID cd99f61579194767aaa958a29d8de88e639d1578
> ># Parent  55c6788c54e2faf80ec14f2b0844bfe429012bc3
> >help: format ``commands`` heading correctly
> Kostia also send this patch out (see
> https://patchwork.mercurial-scm.org/patch/19579/), and either one will work
> fine. Let's just get one of them in.
>
> Sorry for breaking this when I renamed the section. I should probably add a
> check-code for this as penance.

I saw this one first, so I queued this one. Thanks both for the fix.

(We should definitely get some sort of test that'll catch this in the future.)

>
> >
> >The number of dashes under it needs to match exactly for it to be
> >rendered as a heading. Without this change, the dashes end up on the
> >same line as "commands", and "hg help config.commands" does not work.
> >
> >diff -r 55c6788c54e2 -r cd99f6157919 mercurial/help/config.txt
> >--- a/mercurial/help/config.txt	Tue Mar 21 22:47:49 2017 -0700
> >+++ b/mercurial/help/config.txt	Wed Mar 22 16:36:53 2017 -0700
> >@@ -415,7 +415,7 @@
> >      extension).
> >  ``commands``
> >-----------
> >+------------
> >  ``update.requiredest``
> >      Require that the user pass a destination when running ``hg update``.
> >
>
> _______________________________________________
> Mercurial-devel mailing list
> Mercurial-devel@mercurial-scm.org
> https://www.mercurial-scm.org/mailman/listinfo/mercurial-devel

Patch

diff -r 55c6788c54e2 -r cd99f6157919 mercurial/help/config.txt
--- a/mercurial/help/config.txt	Tue Mar 21 22:47:49 2017 -0700
+++ b/mercurial/help/config.txt	Wed Mar 22 16:36:53 2017 -0700
@@ -415,7 +415,7 @@ 
     extension).
 
 ``commands``
-----------
+------------
 
 ``update.requiredest``
     Require that the user pass a destination when running ``hg update``.