[PATCH] help: reword explanation line for developer interfaces

Fangyi Zhou via GitGitGadget· Sep 16, 2022, 13:05 UTC · lore

From: Fangyi Zhou <me@fangyi.io>

Signed-off-by: Fangyi Zhou <me@fangyi.io>
---
    help: reword explanation line for developer interfaces
    
    Signed-off-by: Fangyi Zhou me@fangyi.io

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-git-1330%2Ffangyi-zhou%2Fhelp-doc-fix-v1
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-git-1330/fangyi-zhou/help-doc-fix-v1
Pull-Request: https://github.com/git/git/pull/1330

 help.c          | 2 +-
 t/t0012-help.sh | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

Show changes to 2 files +2 −2

help.c, t/t0012-help.sh

diff --git a/help.c b/help.c
index ec670d5f68b..d04542d8261 100644
--- a/help.c
+++ b/help.c
@@ -39,7 +39,7 @@ static struct category_description main_categories[] = {
 	{ CAT_synchingrepositories, N_("Low-level Commands / Syncing Repositories") },
 	{ CAT_purehelpers, N_("Low-level Commands / Internal Helpers") },
 	{ CAT_userinterfaces, N_("User-facing repository, command and file interfaces") },
-	{ CAT_developerinterfaces, N_("Developer-facing file file formats, protocols and interfaces") },
+	{ CAT_developerinterfaces, N_("Developer-facing file formats, protocols and other interfaces") },
 	{ 0, NULL }
 };
 
diff --git a/t/t0012-help.sh b/t/t0012-help.sh
index 4ed2f242eb2..dbfc5c82676 100755
--- a/t/t0012-help.sh
+++ b/t/t0012-help.sh
@@ -231,7 +231,7 @@ test_expect_success "'git help -a' section spacing" '
 
 	User-facing repository, command and file interfaces
 
-	Developer-facing file file formats, protocols and interfaces
+	Developer-facing file formats, protocols and other interfaces
 	EOF
 	test_cmp expect actual
 '

base-commit: d3fa443f97e3a8d75b51341e2d5bac380b7422df

-- 
gitgitgadget

Junio C Hamano· Sep 16, 2022, 16:19 UTC · re: Fangyi Zhou via GitGitGadget · lore

Re: [PATCH] help: reword explanation line for developer interfaces

"Fangyi Zhou via GitGitGadget" <gitgitgadget@gmail.com> writes:

Show 7 quoted lines

> From: Fangyi Zhou <me@fangyi.io>
>
> Signed-off-by: Fangyi Zhou <me@fangyi.io>
> ---
>     help: reword explanation line for developer interfaces
>     
>     Signed-off-by: Fangyi Zhou me@fangyi.io

> -	{ CAT_developerinterfaces, N_("Developer-facing file file formats, protocols and interfaces") },
> +	{ CAT_developerinterfaces, N_("Developer-facing file formats, protocols and other interfaces") },

Yuck.  Thanks for catching this.

Show 14 quoted lines

>  	{ 0, NULL }
>  };
>  
> diff --git a/t/t0012-help.sh b/t/t0012-help.sh
> index 4ed2f242eb2..dbfc5c82676 100755
> --- a/t/t0012-help.sh
> +++ b/t/t0012-help.sh
> @@ -231,7 +231,7 @@ test_expect_success "'git help -a' section spacing" '
>  
>  	User-facing repository, command and file interfaces
>  
> -	Developer-facing file file formats, protocols and interfaces
> +	Developer-facing file formats, protocols and other interfaces
>  	EOF

Apparently the writer of the test was not doing a good job; and of course the reviewers, too X-.

These all came from 844739ba (git docs: add a category for file formats, protocols and interfaces, 2022-08-04), as a part of a large series.

Will queue.

patchhelp: reword explanation line for developer interfaces