Patchwork [2,of,2] commands: lowercase the first words in each note RFC

login
register
mail settings
Submitter timeless@mozdev.org
Date Dec. 18, 2015, 7:09 p.m.
Message ID <935e6c33b6903d290c40.1450465764@waste.org>
Download mbox | patch
Permalink /patch/12166/
State Rejected
Headers show

Comments

timeless@mozdev.org - Dec. 18, 2015, 7:09 p.m.
# HG changeset patch
# User timeless <timeless@mozdev.org>
# Date 1450455733 0
#      Fri Dec 18 16:22:13 2015 +0000
# Node ID 935e6c33b6903d290c40832077efbacbaa777afc
# Parent  20efc5315455ada3ad351c9c9d2283a1b1e7583c
commands: lowercase the first words in each note RFC

most notes don't start with a capital letter
does anyone care?
Matt Mackall - Dec. 21, 2015, 6:14 p.m.
On Fri, 2015-12-18 at 13:09 -0600, timeless wrote:
> # HG changeset patch
> # User timeless <timeless@mozdev.org>
> # Date 1450455733 0
> #      Fri Dec 18 16:22:13 2015 +0000
> # Node ID 935e6c33b6903d290c40832077efbacbaa777afc
> # Parent  20efc5315455ada3ad351c9c9d2283a1b1e7583c
> commands: lowercase the first words in each note RFC

I've taken the first one, but it's not obvious to me that this one is
the right choice. I think we'd have to look at all the output
renderings. Our built-in rendering with minirst looks like this:

    Note:
       To check out earlier revisions, you should use "hg update REV". To
       cancel an uncommitted merge (and lose your changes), use "hg update
       --clean .".

Since the "To" starts on a separate line from "Note:", I think it's
appropriate to uppercase it.
timeless - Dec. 22, 2015, 2:16 a.m.
Matt Mackall wrote:
> but it's not obvious to me that this one is the right choice.

Thanks for looking. By sending this, I got an extra pair of eyeballs
to think about it :)

> I think we'd have to look at all the output renderings.
> Our built-in rendering with minirst looks like this:
>
>     Note:
>        To check out earlier revisions, you should use "hg update REV". To
>        cancel an uncommitted merge (and lose your changes), use "hg update
>        --clean .".
>
> Since the "To" starts on a separate line from "Note:", I think it's
> appropriate to uppercase it.

I think you're right.
Reviewing the lowercase items, I see two cases:
1. (commandname) ...
2. buggy

def log(ui, repo, *pats, **opts):
    """show revision history of entire repository or files
...
    .. note::

       log -p/--patch may generate unexpected diff output for merge
       changesets, as it will only compare the merge changeset against
       its first parent. Also, only files different from BOTH parents
       will appear in files:.

    .. note::

       for performance reasons, log FILE may omit duplicate changes
       made on branches and will not show removals or mode changes. To
       see all such changes, use the --removed switch.


Shows both. I'll send a series that replaces the former w/ :hg:`...`
and the latter w/ uppercase.

Patch

diff --git a/mercurial/commands.py b/mercurial/commands.py
--- a/mercurial/commands.py
+++ b/mercurial/commands.py
@@ -1167,7 +1167,7 @@ 
 
     .. note::
 
-       Branch names are permanent and global. Use :hg:`bookmark` to create a
+       branch names are permanent and global. Use :hg:`bookmark` to create a
        light-weight bookmark instead. See :hg:`help glossary` for more
        information about named branches and bookmarks.
 
@@ -3821,7 +3821,7 @@ 
 
     .. note::
 
-       The -c/--continue option does not reapply earlier options, except
+       the -c/--continue option does not reapply earlier options, except
        for --force.
 
     .. container:: verbose
@@ -5626,7 +5626,7 @@ 
 
     .. note::
 
-       Extra care should be taken with the -f/--force option,
+       extra care should be taken with the -f/--force option,
        which will push all new heads on all branches, an action which will
        almost always cause confusion for collaborators.
 
@@ -6010,8 +6010,11 @@ 
 
     .. note::
 
-       To check out earlier revisions, you should use :hg:`update REV`.
-       To cancel an uncommitted merge (and lose your changes),
+       to check out earlier revisions, you should use :hg:`update REV`.
+
+    .. note::
+
+       to cancel an uncommitted merge (and lose your changes),
        use :hg:`update --clean .`.
 
     With no revision specified, revert the specified files or directories