unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#47054: Interlink docstrings of ‘delete’ and ‘remove’
@ 2021-03-10 17:12 Juri Linkov
  2021-03-11 16:35 ` Lars Ingebrigtsen
  0 siblings, 1 reply; 3+ messages in thread
From: Juri Linkov @ 2021-03-10 17:12 UTC (permalink / raw)
  To: 47054

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?





^ permalink raw reply	[flat|nested] 3+ messages in thread

* bug#47054: Interlink docstrings of ‘delete’ and ‘remove’
  2021-03-10 17:12 bug#47054: Interlink docstrings of ‘delete’ and ‘remove’ Juri Linkov
@ 2021-03-11 16:35 ` Lars Ingebrigtsen
  2021-03-11 19:08   ` Juri Linkov
  0 siblings, 1 reply; 3+ messages in thread
From: Lars Ingebrigtsen @ 2021-03-11 16:35 UTC (permalink / raw)
  To: Juri Linkov; +Cc: 47054

Juri Linkov <juri@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





^ permalink raw reply	[flat|nested] 3+ messages in thread

* bug#47054: Interlink docstrings of ‘delete’ and ‘remove’
  2021-03-11 16:35 ` Lars Ingebrigtsen
@ 2021-03-11 19:08   ` Juri Linkov
  0 siblings, 0 replies; 3+ messages in thread
From: Juri Linkov @ 2021-03-11 19:08 UTC (permalink / raw)
  To: Lars Ingebrigtsen; +Cc: 47054

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.





^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2021-03-11 19:08 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-03-10 17:12 bug#47054: Interlink docstrings of ‘delete’ and ‘remove’ Juri Linkov
2021-03-11 16:35 ` Lars Ingebrigtsen
2021-03-11 19:08   ` Juri Linkov

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).