GNU bug report logs - #47054
Interlink docstrings of ‘delete’ and ‘remove’

Previous Next

Package: emacs;

Reported by: Juri Linkov <juri <at> linkov.net>

Date: Wed, 10 Mar 2021 17:19:02 UTC

Severity: wishlist

Tags: fixed

Fixed in version 28.0.50

Done: Juri Linkov <juri <at> linkov.net>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox

Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#47054; Package emacs. (Wed, 10 Mar 2021 17:19:02 GMT) Full text and rfc822 format available.
Acknowledgement sent to Juri Linkov <juri <at> linkov.net>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Wed, 10 Mar 2021 17:19:02 GMT) Full text and rfc822 format available.

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

From: Juri Linkov <juri <at> linkov.net>
To: bug-gnu-emacs <at> gnu.org
Subject: Interlink docstrings of ‘delete’ and
 ‘remove’
Date: Wed, 10 Mar 2021 19:12:37 +0200

The docstring of ‘delq’ links to ‘remq’:

  See also ‘remq’, which does not modify the argument.

The docstring of ‘remq’ links back to ‘delq’:

  Contrary to ‘delq’, this does not use side-effects,
  and the argument LIST is not modified.

Shouldn't docstrings of ‘delete’ and ‘remove’ do the same
and refer each other?
Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#47054; Package emacs. (Thu, 11 Mar 2021 16:36:02 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Juri Linkov <juri <at> linkov.net>
Cc: 47054 <at> debbugs.gnu.org
Subject: Re: bug#47054: Interlink docstrings of ‘delete’
 and ‘remove’
Date: Thu, 11 Mar 2021 17:35:23 +0100

Juri Linkov <juri <at> linkov.net> writes:

> Shouldn't docstrings of ‘delete’ and ‘remove’ do the same
> and refer each other?

I think they should.  In general, function docstrings mention related
functions too little, I think.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no
Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#47054; Package emacs. (Thu, 11 Mar 2021 19:10:02 GMT) Full text and rfc822 format available.

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

From: Juri Linkov <juri <at> linkov.net>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: 47054 <at> debbugs.gnu.org
Subject: Re: bug#47054: Interlink docstrings of ‘delete’
 and ‘remove’
Date: Thu, 11 Mar 2021 21:08:52 +0200

tags 47054 fixed
close 47054 28.0.50
quit

>> Shouldn't docstrings of ‘delete’ and ‘remove’ do the same
>> and refer each other?
>
> I think they should.  In general, function docstrings mention related
> functions too little, I think.

To not increase entropy, I copied the same text from delq/remq
to delete/remove docstrings.
Added tag(s) fixed. Request was from Juri Linkov <juri <at> linkov.net> to control <at> debbugs.gnu.org. (Thu, 11 Mar 2021 19:10:02 GMT) Full text and rfc822 format available.
bug marked as fixed in version 28.0.50, send any further explanations to 47054 <at> debbugs.gnu.org and Juri Linkov <juri <at> linkov.net> Request was from Juri Linkov <juri <at> linkov.net> to control <at> debbugs.gnu.org. (Thu, 11 Mar 2021 19:10:02 GMT) Full text and rfc822 format available.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Fri, 09 Apr 2021 11:24:07 GMT) Full text and rfc822 format available.
This bug report was last modified 4 years and 131 days ago.

Previous Next

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