GNU bug report logs - #30085
25.2: Documentation for cua-rectangle-mark-mode

Previous Next

Package: emacs;

Reported by: Boruch Baum <boruch_baum <at> gmx.com>

Date: Fri, 12 Jan 2018 07:15:01 UTC

Severity: minor

Found in version 25.2

Full log


Message #44 received at 30085 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefan <at> marxist.se>
To: Eli Zaretskii <eliz <at> gnu.org>
Cc: 30085 <at> debbugs.gnu.org, boruch_baum <at> gmx.com, storm <at> cua.dk
Subject: Re: bug#30085: 25.2: Documentation for cua-rectangle-mark-mode
Date: Mon, 26 Oct 2020 18:39:53 -0700
Eli Zaretskii <eliz <at> gnu.org> writes:

> If Kim doesn't respond, as he didn't back then, I suggest you use your
> best judgment to retain whatever seems useful from this patch.
>
> Internal functions indeed don't need to be documented, but if the doc
> string makes a significant difference in how easy it is to understand
> what the function does, including a doc string can only help future
> maintenance.

So I finally had a look and pushed the relevant documentation changes.
In effect large parts of the patch was converting existing comments into
docstrings.  They aren't the most beautiful in all cases, but definitely
better than nothing.




This bug report was last modified 4 years and 183 days ago.

Previous Next


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