Re: Is it ok to sort a list of overlays destructively?

[Marcin Borkowski]

On 2021-07-28, at 04:25, Eli Zaretskii <eliz@gnu.org> wrote:

>> From: Marcin Borkowski <mbork@mbork.pl>
>> Cc: help-gnu-emacs@gnu.org
>> Date: Tue, 27 Jul 2021 22:14:39 +0200
>> 
>> > The doc string kinda hints on that, since it talks about sorting the
>> > list, which would be unthinkable if it were the internal storage.
>> 
>> --8<---------------cut here---------------start------------->8---
>> Return a list of the overlays that overlap the region BEG ... END.
>> Overlap means that at least one character is contained within the overlay
>> and also contained within the specified region.
>> Empty overlays are included in the result if they are located at BEG,
>> between BEG and END, or at END provided END denotes the position at the
>> end of the buffer.
>> --8<---------------cut here---------------end--------------->8---
>> 
>> Where does it say anything about sorting?
>
> Look at overlays-at.

Ah, thanks.

Would it be a good idea to say explicitly in the docstrings of both
functions that their results may be safely modified destructively?  If
so, I can file a bug report.

TIA,

-- 
Marcin Borkowski
http://mbork.pl