From: Dmitry Gutov <dgutov@yandex.ru>
To: Robert Weiner <rswgnu@gmail.com>
Cc: emacs-devel <emacs-devel@gnu.org>
Subject: Re: xref rocks!
Date: Wed, 27 Apr 2016 16:13:05 +0300 [thread overview]
Message-ID: <7798d95a-e5fa-44ed-7272-b997fa9b6294@yandex.ru> (raw)
In-Reply-To: <CA+OMD9gVFbWRcr86wNXC5t4OhbanjLv3r1WwjsXGiO+KNWx0Eg@mail.gmail.com>
On 04/27/2016 06:35 AM, Robert Weiner wrote:
> Yes, that is helpful. So why not include a wrapper for the API of
> something like:
> (xref-get-definitions "car")
That seems unnecessary. And you yourself complained about the wrappers
that don't do much.
> xref-find-definitions calls only xref--find-definitions which calls
> only xref--find-xrefs which essentially calls only xref--show-xrefs.
Hmm, I suppose we could eliminate xref--find-definitions, but then each
of xref-find-definitions-other-window,
xref-find-definitions-other-window and xref-find-definitions-other-frame
will have to call xref--find-xrefs with a bit more complex sets of
arguments. An extra indirection don't seem a big enough problem to
justify this.
> I have read it. It certainly points to many places in the package and
> in the backend implementations to look for more documentation but
> doesn't give a sense of how to use the package after defining a backend,
Just like you've used it before that?
> i.e. what commands are available and what parameters do they require, or
To see the available commands type `M-x xref- TAB'. If you mean
functions, then `C-h f xref- TAB'. Although yes, a friendly explanation
along the lines of "do this and that go that that" should have its place
in the manual.
> for programmers, what do the resulting API calls look like?
Not sure I understand. What does look like? The implementations of the
generic methods? They return lists of xref values.
> Including a
> simple sample backend, much simpler than referencing the existing
> backends, would also help a lot to show the minimum involved in creating
> a backend. Think of someone who knows Elisp and Emacs but knows nothing
> about xrefs.
That sounds like manual material. I think writing it is premature at
this point, but sure, we should have it eventually.
next prev parent reply other threads:[~2016-04-27 13:13 UTC|newest]
Thread overview: 10+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-04-25 11:35 xref rocks! Nicolas Petton
2016-04-25 20:57 ` Dmitry Gutov
2016-04-25 21:05 ` Nicolas Petton
2016-04-26 17:12 ` Robert Weiner
2016-04-26 20:41 ` Dmitry Gutov
2016-04-27 3:35 ` Robert Weiner
2016-04-27 13:13 ` Dmitry Gutov [this message]
2016-04-27 15:58 ` Robert Weiner
2016-04-26 14:49 ` John Wiegley
2016-04-26 20:29 ` Dmitry Gutov
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=7798d95a-e5fa-44ed-7272-b997fa9b6294@yandex.ru \
--to=dgutov@yandex.ru \
--cc=emacs-devel@gnu.org \
--cc=rswgnu@gmail.com \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.