GNU bug report logs - #61736
Fix typos in docstrings in c-ts-common.el

Previous Next

Full log

Message #13 received at 61736-done <at> debbugs.gnu.org (full text, mbox):

From: Yuan Fu <casouri <at> gmail.com>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 61736-done <at> debbugs.gnu.org,
 Daniel Martín <mardani29 <at> yahoo.es>
Subject: Re: bug#61736: Fix typos in docstrings in c-ts-common.el
Date: Fri, 24 Feb 2023 20:50:48 -0800

Eli Zaretskii <eliz <at> 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 <at> 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

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.