diff mbox series

[v1,3/3] difftool: add space after full stop in comments

Message ID 20211002184407.117282-4-rybak.a.v@gmail.com (mailing list archive)
State New, archived
Headers show
Series Typofixes | expand

Commit Message

Andrei Rybak Oct. 2, 2021, 6:44 p.m. UTC
These punctuation typos were found using:

    git grep -P ' [a-z0-9A-Z-]+[.][A-Z][A-Za-z-]+ '

Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
---

I've also looked for similar typos around commas and semicolons and didn't find
any.

 builtin/difftool.c | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

Elijah Newren Oct. 2, 2021, 7:36 p.m. UTC | #1
On Sat, Oct 2, 2021 at 11:49 AM Andrei Rybak <rybak.a.v@gmail.com> wrote:
>
> These punctuation typos were found using:
>
>     git grep -P ' [a-z0-9A-Z-]+[.][A-Z][A-Za-z-]+ '

While Junio has commented that two spaces after the full stop in
fixed-width source code viewing looks better, and I personally prefer
that style as well, I don't think these are worth "fixing".  I'm glad
you separated this from the other changes, but I'd rather see this
patch dropped.

>
> Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
> ---
>
> I've also looked for similar typos around commas and semicolons and didn't find
> any.
>
>  builtin/difftool.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/builtin/difftool.c b/builtin/difftool.c
> index bb9fe7245a..d9a4e55caf 100644
> --- a/builtin/difftool.c
> +++ b/builtin/difftool.c
> @@ -529,7 +529,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
>                 goto finish;
>
>         /*
> -        * Changes to submodules require special treatment.This loop writes a
> +        * Changes to submodules require special treatment. This loop writes a
>          * temporary file to both the left and right directories to show the
>          * change in the recorded SHA1 for the submodule.
>          */
> @@ -548,7 +548,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
>         }
>
>         /*
> -        * Symbolic links require special treatment.The standard "git diff"
> +        * Symbolic links require special treatment. The standard "git diff"
>          * shows only the link itself, not the contents of the link target.
>          * This loop replicates that behavior.
>          */
> --
> 2.33.0
Carlo Marcelo Arenas Belón Oct. 2, 2021, 8:12 p.m. UTC | #2
On Sat, Oct 2, 2021 at 12:38 PM Elijah Newren <newren@gmail.com> wrote:
>
> On Sat, Oct 2, 2021 at 11:49 AM Andrei Rybak <rybak.a.v@gmail.com> wrote:
> >
> > These punctuation typos were found using:
> >
> >     git grep -P ' [a-z0-9A-Z-]+[.][A-Z][A-Za-z-]+ '
>
> While Junio has commented that two spaces after the full stop in
> fixed-width source code viewing looks better, and I personally prefer
> that style as well, I don't think these are worth "fixing".

FWIW those are not adding a second space, but adding ANY space between
a "." and beginning of the next sentence.

> you separated this from the other changes, but I'd rather see this
> patch dropped.

While I don't think encouraging this kind of "fixes" might make sense,
the work was already done and the "churn" is very small (only 2 places
out of ~2K), where we have in the codebase: ".<space><space>"

Carlo
Elijah Newren Oct. 2, 2021, 11:41 p.m. UTC | #3
On Sat, Oct 2, 2021 at 1:12 PM Carlo Arenas <carenas@gmail.com> wrote:
>
> On Sat, Oct 2, 2021 at 12:38 PM Elijah Newren <newren@gmail.com> wrote:
> >
> > On Sat, Oct 2, 2021 at 11:49 AM Andrei Rybak <rybak.a.v@gmail.com> wrote:
> > >
> > > These punctuation typos were found using:
> > >
> > >     git grep -P ' [a-z0-9A-Z-]+[.][A-Z][A-Za-z-]+ '
> >
> > While Junio has commented that two spaces after the full stop in
> > fixed-width source code viewing looks better, and I personally prefer
> > that style as well, I don't think these are worth "fixing".
>
> FWIW those are not adding a second space, but adding ANY space between
> a "." and beginning of the next sentence.

Oh!  I didn't look closely enough (I'll blame gmail's variable-width
font).  Thanks for correcting me.  Yes, if there's no space at all
between the full stop and the next character, then that makes it more
annoying.  So, ignore what I said earlier, I think this patch is good.
David Aguilar Oct. 11, 2021, 3:42 p.m. UTC | #4
On Sat, Oct 2, 2021 at 11:49 AM Andrei Rybak <rybak.a.v@gmail.com> wrote:
>
> These punctuation typos were found using:
>
>     git grep -P ' [a-z0-9A-Z-]+[.][A-Z][A-Za-z-]+ '
>
> Signed-off-by: Andrei Rybak <rybak.a.v@gmail.com>
> ---
>
> I've also looked for similar typos around commas and semicolons and didn't find
> any.
>
>  builtin/difftool.c | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/builtin/difftool.c b/builtin/difftool.c
> index bb9fe7245a..d9a4e55caf 100644
> --- a/builtin/difftool.c
> +++ b/builtin/difftool.c
> @@ -529,7 +529,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
>                 goto finish;
>
>         /*
> -        * Changes to submodules require special treatment.This loop writes a
> +        * Changes to submodules require special treatment. This loop writes a
>          * temporary file to both the left and right directories to show the
>          * change in the recorded SHA1 for the submodule.
>          */
> @@ -548,7 +548,7 @@ static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
>         }
>
>         /*
> -        * Symbolic links require special treatment.The standard "git diff"
> +        * Symbolic links require special treatment. The standard "git diff"
>          * shows only the link itself, not the contents of the link target.
>          * This loop replicates that behavior.
>          */

Heads-up -- this 2nd hunk is already in "next". Please see:

28c10ecbfc (difftool: add a missing space to the run_dir_diff()
comments, 2021-09-30)

The 1st hunk above it (submodules) is still relevant.

It might be worth rebasing this patch against the da/difftool topic in
"next". This patch should become a one-liner once that's done.
diff mbox series

Patch

diff --git a/builtin/difftool.c b/builtin/difftool.c
index bb9fe7245a..d9a4e55caf 100644
--- a/builtin/difftool.c
+++ b/builtin/difftool.c
@@ -529,7 +529,7 @@  static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
 		goto finish;
 
 	/*
-	 * Changes to submodules require special treatment.This loop writes a
+	 * Changes to submodules require special treatment. This loop writes a
 	 * temporary file to both the left and right directories to show the
 	 * change in the recorded SHA1 for the submodule.
 	 */
@@ -548,7 +548,7 @@  static int run_dir_diff(const char *extcmd, int symlinks, const char *prefix,
 	}
 
 	/*
-	 * Symbolic links require special treatment.The standard "git diff"
+	 * Symbolic links require special treatment. The standard "git diff"
 	 * shows only the link itself, not the contents of the link target.
 	 * This loop replicates that behavior.
 	 */