bug#61736: Fix typos in docstrings in c-ts-common.el

bug#61736: Fix typos in docstrings in c-ts-common.el

[Daniel Martín via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 81 bytes --]

Tags: patch


I've attached a patch to fix a couple of typos in c-ts-common.el.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Fix-typos-in-docstrings-in-c-ts-common.el.patch --]
[-- Type: text/patch, Size: 1231 bytes --]

From 3f110b0f7de1bd1f1e00b39fc48608ef9ef189c6 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Mart=C3=ADn?= <mardani29@yahoo.es>
Date: Thu, 23 Feb 2023 18:30:36 +0100
Subject: [PATCH] ; Fix typos in docstrings in c-ts-common.el

---
 lisp/progmodes/c-ts-common.el | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/lisp/progmodes/c-ts-common.el b/lisp/progmodes/c-ts-common.el
index 8262e6261d4..55a6ab64aa3 100644
--- a/lisp/progmodes/c-ts-common.el
+++ b/lisp/progmodes/c-ts-common.el
@@ -268,7 +268,7 @@ c-ts-common-indent-offset
 statement indent functions to work.")
 
 (defvar c-ts-common-indent-type-regexp-alist nil
-  "An alist of of node type regexps.
+  "An alist of node type regexps.
 
 Each key in the alist is one of `if', `else', `do', `while',
 `for', `block', `close-bracket'.  Each value in the alist
@@ -313,7 +313,7 @@ c-ts-common--node-is
     nil))
 
 (defun c-ts-common-statement-offset (node parent &rest _)
-  "This anchor is used for children of a statement inside a block.
+  "Return an offset for children of a statement inside a block.
 
 This function basically counts the number of block nodes (i.e.,
 brackets) (defined by `c-ts-common-indent-block-type-regexp')
-- 
2.34.1

bug#61736: Fix typos in docstrings in c-ts-common.el

[Eli Zaretskii]

> Date: Thu, 23 Feb 2023 18:32:58 +0100
> From:  Daniel Martín via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> I've attached a patch to fix a couple of typos in c-ts-common.el.

Thanks.

>  (defun c-ts-common-statement-offset (node parent &rest _)
> -  "This anchor is used for children of a statement inside a block.
> +  "Return an offset for children of a statement inside a block.

Is the new text really accurate?  The rest of the doc string doesn'
mention "offset" even once, and without explaining what kind of
"offset" is this, the first sentence could mislead and confuse.

So I think this part of the patch "needs more work".

I installed the first part, thanks.

bug#61736: Fix typos in docstrings in c-ts-common.el

[Yuan Fu]

Eli Zaretskii <eliz@gnu.org> writes:

>> Date: Thu, 23 Feb 2023 18:32:58 +0100
>> From:  Daniel Martín via "Bug reports for GNU Emacs,
>>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>> 
>> I've attached a patch to fix a couple of typos in c-ts-common.el.
>
> Thanks.
>
>>  (defun c-ts-common-statement-offset (node parent &rest _)
>> -  "This anchor is used for children of a statement inside a block.
>> +  "Return an offset for children of a statement inside a block.
>
> Is the new text really accurate?  The rest of the doc string doesn'
> mention "offset" even once, and without explaining what kind of
> "offset" is this, the first sentence could mislead and confuse.
>
> So I think this part of the patch "needs more work".
>
> I installed the first part, thanks.

The second part is valid. I applied it with some minor change, thanks!

Yuan