unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Drew Adams <drew.adams@oracle.com>
To: 38183@debbugs.gnu.org
Subject: bug#38183: 26.3; Doc about equality of markers
Date: Tue, 12 Nov 2019 11:03:20 -0800 (PST)	[thread overview]
Message-ID: <104e3572-fe9c-42b8-a099-769389ff1588@default> (raw)

I think the doc about equality of markers should be improved.

In the Elisp manual:

Nodes `Equality Predicates' and `Overview of Markers' point out _one_
difference between `eq' and `equal', for markers.  But in both of these
nodes the examples and explanations involve only markers for the same
buffer.

In node `Creating Markers' we finally find get the information that
`equal' requires the markers to also be for the same buffer.  But again,
the examples there show only markers for the same buffer.  There should
be an example with `equal' for markers with same numerical value but for
different buffers.

Node `Comparison of Numbers' tells us how to compare markers only with
respect to their numerical values, i.e., to ignore a buffer difference.

This info should be brought together, so that wherever we speak of
equality tests for markers we can learn that (1) `eq' requires the
markers to be identical (the same marker object), (2) `equal' requires
them to have the same numerical value and be for the same buffer, and
(3) `=' requires them to just have the same numerical value.

At the very least, all of that info should be available in one place, in
the section about markers.  And it should include simple examples (like
now, but including `=' and the case of `equal' for two markers with the
same numerical value but for different buffers).

I think the info belongs in `Overview of Markers'.  (But it could
logically be in `Predicates on Markers'.)

In particular, this is not something that's particular to `Creating
Markers'.  IMO you could remove the examples of this kind of thing from
the description of `copy-marker'.  But if duplication is OK then it's OK
to repeat it there.  The point is that that shouldn't be the only place
to find this info.

In GNU Emacs 26.3 (build 1, x86_64-w64-mingw32)
 of 2019-08-29
Repository revision: 96dd0196c28bc36779584e47fffcca433c9309cd
Windowing system distributor `Microsoft Corp.', version 10.0.17763
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install 'CFLAGS=-O2 -static -g3''





             reply	other threads:[~2019-11-12 19:03 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-11-12 19:03 Drew Adams [this message]
2019-11-15 13:18 ` bug#38183: 26.3; Doc about equality of markers Eli Zaretskii
     [not found] <<104e3572-fe9c-42b8-a099-769389ff1588@default>
     [not found] ` <<83eey92s7m.fsf@gnu.org>
2019-11-15 17:26   ` Drew Adams
2019-11-15 17:35     ` Eli Zaretskii
     [not found] <<<104e3572-fe9c-42b8-a099-769389ff1588@default>
     [not found] ` <<<83eey92s7m.fsf@gnu.org>
     [not found]   ` <<dff3319b-b0d9-4137-a732-33ac97f031c7@default>
     [not found]     ` <<83tv7511r3.fsf@gnu.org>
2019-11-15 18:27       ` Drew Adams
2019-11-15 19:26         ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=104e3572-fe9c-42b8-a099-769389ff1588@default \
    --to=drew.adams@oracle.com \
    --cc=38183@debbugs.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).