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

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Daniel Martín <mardani29 <at> yahoo.es>
Cc: 61736 <at> debbugs.gnu.org
Subject: bug#61736: Fix typos in docstrings in c-ts-common.el
Date: Thu, 23 Feb 2023 19:52:18 +0200

> 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.

Previous Next

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