From: Max Nikulin <manikulin@gmail.com>
To: Bruno Cardoso <cardoso.bc@gmail.com>, emacs-orgmode@gnu.org
Subject: Re: [PATCH] Add support for shortdoc link type
Date: Wed, 8 May 2024 18:20:05 +0700 [thread overview]
Message-ID: <a204b9af-a37d-46a1-94bd-2f96fd256b94@gmail.com> (raw)
In-Reply-To: <87v83pnm56.fsf@gmail.com>
On 08/05/2024 08:11, Bruno Cardoso wrote:
>
> The following now work as expected:
>
> - [[shortdoc:string]]
> - [[shortdoc:string::#try-completion]]
> - [[shortdoc:string::identical contents]]
Thanks.
Bruno, the patch should have proper commit message, see
<https://orgmode.org/worg/org-contribute.html#commit-messages>
Some minor notes:
> +++ b/doc/org-manual.org
> @@ -3382,6 +3382,15 @@ Here is the full set of built-in link types:
>
> Execute a shell command upon activation.
>
> +- =shortdoc= ::
> +
> + Link to short documentation summary for an Emacs Lisp function group.
> + Since Emacs 28, user command ~shortdoc-display-group~ lists all known
> + documentation groups.
I have not managed to get all known groups with `shortdoc-display-group'
in Emacs-28. Is it a feature of `shortdoc' in Emacs-29?
> + (string-match "\\`\\([^:]*\\)\\(?:::\\(.*\\).*\\'\\)?" path)
My bad. In
"\\`\\([^:]*\\)\\(?:::#\\(.*\\).*\\'\\)?"
second .* was unnecessary, it survived from an earlier variant with \\|
and \\' outside of the regex group.
Likely it is better to not allow empty group or function, so "+" instead
of "*"
"\\`\\([^:]+\\)\\(?:::\\(.+\\)\\'\\)?"
since <shortdoc:::file> is hardly a valid link. However it might be
search text link in the list of all groups (Emacs-29+ only?).
It is related to corner cases, so I do not insist.
> + (let* ((group (match-string 1 path))
> + (str (match-string 2 path))
> + (fn (when (and str (string-match "^#" str))
> + (intern-soft (string-remove-prefix "#" str)))))
Nitpick, feel free to ignore:
- `when' is redundant here due to `and' inside its condition.
- `string-patch-p' would not affect match groups, so it is a bit cheaper.
- Since it is already known that first character is "#", `substring'
instead of `string-remove-prefix' is an extra step in microoptimization
Untested: (fn (and str (eq ?# (string-to-char str)) (substring str 1)))
next prev parent reply other threads:[~2024-05-08 11:21 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-05-01 3:29 [PATCH] Add support for shortdoc link type Bruno Cardoso
2024-05-01 11:00 ` Ihor Radchenko
2024-05-01 16:52 ` Bruno Cardoso
2024-05-01 17:55 ` Ihor Radchenko
2024-05-01 19:24 ` Bruno Cardoso
2024-05-02 10:41 ` Max Nikulin
2024-05-03 21:41 ` Bruno Cardoso
2024-05-04 7:38 ` Max Nikulin
2024-05-04 17:33 ` Bruno Cardoso
2024-05-05 11:01 ` Max Nikulin
2024-05-05 21:35 ` Bruno Cardoso
2024-05-06 10:55 ` Max Nikulin
2024-05-08 1:11 ` Bruno Cardoso
2024-05-08 11:20 ` Max Nikulin [this message]
2024-05-08 21:26 ` Bruno Cardoso
2024-05-10 11:09 ` Max Nikulin
2024-05-11 16:58 ` Bruno Cardoso
2024-05-13 11:14 ` Max Nikulin
2024-05-13 13:04 ` Bruno Cardoso
2024-05-16 10:58 ` Max Nikulin
2024-05-17 14:55 ` Bruno Cardoso
2024-06-04 23:59 ` Bruno Cardoso
2024-06-05 15:14 ` Ihor Radchenko
2024-06-05 21:15 ` Bastien Guerry
2024-06-05 15:37 ` Max Nikulin
2024-06-05 22:21 ` Bruno Cardoso
2024-06-06 11:53 ` Ihor Radchenko
2024-06-06 23:11 ` Bruno Cardoso
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.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=a204b9af-a37d-46a1-94bd-2f96fd256b94@gmail.com \
--to=manikulin@gmail.com \
--cc=cardoso.bc@gmail.com \
--cc=emacs-orgmode@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/org-mode.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).