Re: [PATCH] Add support for shortdoc link type

[Max Nikulin]

On 02/05/2024 02:24, Bruno Cardoso wrote:
> +++ b/lisp/ol.el
> @@ -1597,6 +1597,37 @@ PATH is a symbol name, as a string."
>   (org-link-set-parameters "help"
>                            :follow #'org-link--open-help
>                            :store #'org-link--store-help)
> +;;;; "shortdoc" link type
> +(when (version< "27" emacs-version)
> +  (defun org-link--open-shortdoc (group _)
> +    "Open a \"shortdoc\" type link.
> +GROUP is a symbol name."
> +    (if (assoc (intern group) shortdoc--groups)
> +        (shortdoc-display-group group)
> +      (user-error "Unknown shortdoc group: %s" group)))

`condition-case' may help to avoid the internal `shortdoc--groups' 
variable here. As to completion, it is better to ask for public API. 
However emacs developers likely will decline such request.

Consider the following just as ideas.

- Support of search options. Buttons in help pages move point to 
specific functions.

<shortdoc:file::#find-file>

- At first I considered adding shortdoc to help links that may call 
either `describe-function' or `describe-variable', but it is unlikely 
possible.