bug#73487: [PATCH] ; * src/cm.c (cmgoto): Add function documentation

bug#73487: [PATCH] ; * src/cm.c (cmgoto): Add function documentation

[Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors]

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

This proposed patch adds a function documentation where there was none.

Please install on master or provide feedback for further work.



[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-src-cm.c-cmgoto-Add-function-documentation.patch --]
[-- Type: text/x-diff, Size: 606 bytes --]

From 436d482337ad1a88436973337650473e6d7ace41 Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <jb@jeremybryant.net>
Date: Wed, 25 Sep 2024 22:28:04 +0100
Subject: [PATCH] ; * src/cm.c (cmgoto): Add function documentation

---
 src/cm.c | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/src/cm.c b/src/cm.c
index ad419ce0af1..0832eaf84b5 100644
--- a/src/cm.c
+++ b/src/cm.c
@@ -317,6 +317,10 @@ #define	USEHOME	1
 #define	USELL	2
 #define	USECR	3
 
+/*
+ * Move the cursor to (row, col), by computing the optimal way.
+ */
+
 void
 cmgoto (struct tty_display_info *tty, int row, int col)
 {
-- 
2.45.2

bug#73487: [PATCH] ; * src/cm.c (cmgoto): Add function documentation

[Eli Zaretskii]

> Date: Wed, 25 Sep 2024 22:32:56 +0100
> From:  Jeremy Bryant via "Bug reports for GNU Emacs,
>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
> 
> This proposed patch adds a function documentation where there was none.
> 
> Please install on master or provide feedback for further work.

We usually prefer non-block comments, certainly when the comment is
short.  Can you use that in this case?

Thanks.

bug#73487: [PATCH] ; * src/cm.c (cmgoto): Add function documentation

[Jeremy Bryant via Bug reports for GNU Emacs, the Swiss army knife of text editors]

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

Eli Zaretskii <eliz@gnu.org> writes:

>> Date: Wed, 25 Sep 2024 22:32:56 +0100
>> From:  Jeremy Bryant via "Bug reports for GNU Emacs,
>>  the Swiss army knife of text editors" <bug-gnu-emacs@gnu.org>
>> 
>> This proposed patch adds a function documentation where there was none.
>> 
>> Please install on master or provide feedback for further work.
>
> We usually prefer non-block comments, certainly when the comment is
> short.  Can you use that in this case?
>
> Thanks.

Yes, sure.  Revised patch attached with the comment in a single line,
rather than a block.

(I tried to match the style of the surrounding areas of the file but now
realise this was from 1992)

Please install on master or provide feedback for further work.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-src-cm.c-cmgoto-Add-function-documentation.patch --]
[-- Type: text/x-diff, Size: 597 bytes --]

From afc9916447528682d72a6bd9429b2a6e91d4d28a Mon Sep 17 00:00:00 2001
From: Jeremy Bryant <jb@jeremybryant.net>
Date: Wed, 25 Sep 2024 22:28:04 +0100
Subject: [PATCH] ; * src/cm.c (cmgoto): Add function documentation

---
 src/cm.c | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/src/cm.c b/src/cm.c
index ad419ce0af1..e1014af5298 100644
--- a/src/cm.c
+++ b/src/cm.c
@@ -317,6 +317,8 @@ #define	USEHOME	1
 #define	USELL	2
 #define	USECR	3
 
+/* Move the cursor to (row, col), by computing the optimal way. */
+
 void
 cmgoto (struct tty_display_info *tty, int row, int col)
 {
-- 
2.45.2

bug#73487: [PATCH] ; * src/cm.c (cmgoto): Add function documentation

[Eli Zaretskii]

> From: Jeremy Bryant <jb@jeremybryant.net>
> Cc: 73487@debbugs.gnu.org
> Date: Thu, 26 Sep 2024 22:54:36 +0100
> 
> > We usually prefer non-block comments, certainly when the comment is
> > short.  Can you use that in this case?
> >
> > Thanks.
> 
> Yes, sure.  Revised patch attached with the comment in a single line,
> rather than a block.

Thanks, installed, with 2 more nits I failed to mention.

> (I tried to match the style of the surrounding areas of the file but now
> realise this was from 1992)

Yeah, this is WIP...