GNU bug report logs - #54782
[PATCH] Update docstrings for shortdoc.el FUNC lisp form API

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 54782 in the body.
You can then email your comments to 54782 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

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

From: Kaushal Modi <kaushal.modi <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org, Lars Ingebrigtsen <larsi <at> gnus.org>
Subject: [PATCH] Update docstrings for shortdoc.el FUNC lisp form API
Date: Thu, 7 Apr 2022 23:52:32 -0400

[Message part 1 (text/plain, inline)]

Hello,

I have reading through the shortdoc documentation and in the process
ended up with these edits. Can someone please review this?

I have my copyright assigned and I have access to the Emacs git repo.
But I cannot access it via git/SSH protocol (due to technical reasons
at work). So once the patch is ready, I'll need someone's help to
commit it as well.

Thanks!

--
Kaushal Modi

[0001-Update-docstrings-for-shortdoc.el-FUNC-lisp-form-API.patch (application/octet-stream, attachment)]

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Kaushal Modi <kaushal.modi <at> gmail.com>
Cc: 54782 <at> debbugs.gnu.org
Subject: Re: bug#54782: [PATCH] Update docstrings for shortdoc.el FUNC lisp
 form API
Date: Fri, 08 Apr 2022 15:17:31 +0200

Kaushal Modi <kaushal.modi <at> gmail.com> writes:

> I have reading through the shortdoc documentation and in the process
> ended up with these edits. Can someone please review this?

The patch doesn't apply to the current master.  Can you respin it?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

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

From: Kaushal Modi <kaushal.modi <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 54782 <at> debbugs.gnu.org
Subject: Re: bug#54782: [PATCH] Update docstrings for shortdoc.el FUNC lisp
 form API
Date: Fri, 8 Apr 2022 09:18:53 -0400

On Fri, Apr 8, 2022 at 9:17 AM Lars Ingebrigtsen <larsi <at> gnus.org> wrote:

> The patch doesn't apply to the current master.  Can you respin it?

I have based it off emacs-28 as it's just a doc change.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Kaushal Modi <kaushal.modi <at> gmail.com>
Cc: 54782 <at> debbugs.gnu.org
Subject: Re: bug#54782: [PATCH] Update docstrings for shortdoc.el FUNC lisp
 form API
Date: Sat, 09 Apr 2022 11:45:16 +0200

Kaushal Modi <kaushal.modi <at> gmail.com> writes:

> I have based it off emacs-28 as it's just a doc change.

We merge forward to emacs-29, and since this can't be merged as is, I'd
rather it go to emacs-29 directly.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

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

From: Kaushal Modi <kaushal.modi <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 54782 <at> debbugs.gnu.org
Subject: Re: bug#54782: [PATCH] Update docstrings for shortdoc.el FUNC lisp
 form API
Date: Sat, 9 Apr 2022 13:23:34 -0400

[Message part 1 (text/plain, inline)]

On Sat, Apr 9, 2022 at 5:45 AM Lars Ingebrigtsen <larsi <at> gnus.org> wrote:

> We merge forward to emacs-29, and since this can't be merged as is, I'd
> rather it go to emacs-29 directly.

OK, I have attached that patch now rebased to master.

Thanks!

[0001-Update-docstrings-for-shortdoc.el-FUNC-lisp-form-API.patch (application/octet-stream, attachment)]

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Kaushal Modi <kaushal.modi <at> gmail.com>
Cc: 54782 <at> debbugs.gnu.org
Subject: Re: bug#54782: [PATCH] Update docstrings for shortdoc.el FUNC lisp
 form API
Date: Sun, 10 Apr 2022 13:52:25 +0200

Kaushal Modi <kaushal.modi <at> gmail.com> writes:

> OK, I have attached that patch now rebased to master.

Thanks; pushed to Emacs 29.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

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

From: Kaushal Modi <kaushal.modi <at> gmail.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 54782 <at> debbugs.gnu.org
Subject: Re: bug#54782: [PATCH] Update docstrings for shortdoc.el FUNC lisp
 form API
Date: Sun, 10 Apr 2022 09:44:26 -0400

On Sun, Apr 10, 2022 at 7:52 AM Lars Ingebrigtsen <larsi <at> gnus.org> wrote:
>
> Thanks; pushed to Emacs 29.

Thanks!

I see that part of my commit log (the main reason why I started
working on this patch) didn't get pushed. The full commit log was:

"Update docstrings for shortdoc.el FUNC lisp form API

* lisp/emacs-lisp/shortdoc.el (define-short-documentation-group):
Updated docstrings.

(shortdoc-add-function): Escape single quotes so that they don't
convert to curved quotes in *Help* buffers."

This part got missed: "(shortdoc-add-function): Escape single quotes
so that they don't
convert to curved quotes in *Help* buffers." --
https://git.savannah.gnu.org/cgit/emacs.git/patch/?id=cca47ae555bfddf87b4871988555738c335f8457

Was there a mistake in formatting that commit message that caused this?

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Kaushal Modi <kaushal.modi <at> gmail.com>
Cc: 54782 <at> debbugs.gnu.org
Subject: Re: bug#54782: [PATCH] Update docstrings for shortdoc.el FUNC lisp
 form API
Date: Sun, 10 Apr 2022 15:47:02 +0200

Kaushal Modi <kaushal.modi <at> gmail.com> writes:

> Was there a mistake in formatting that commit message that caused this?

No, I probably just hit the wrong key.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

Previous Next

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