emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Magnus Therning <magnus@therning.org>
To: Ihor Radchenko <yantar92@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: [BUG] org-create-file-search-functions and description [9.5.5 (release_9.5.5 @ /usr/share/emacs/29.0.50/lisp/org/)]
Date: Mon, 26 Sep 2022 14:15:47 +0200	[thread overview]
Message-ID: <871qryba4z.fsf@therning.org> (raw)
In-Reply-To: <87k05qjpwg.fsf@localhost>

[-- Attachment #1: Type: text/plain, Size: 2330 bytes --]


Ihor Radchenko <yantar92@gmail.com> writes:

> Magnus Therning <magnus@therning.org> writes:
>
>> The documenation on org-create-file-search-functions contains 
>> this
>> piece of text
>>
>>   A function in this hook may also use setq to set the variable
>>   description to provide a suggestion for the descriptive text 
>>   to
>>   be used for this link when it gets inserted into an Org 
>>   buffer
>>   with org-insert-link.
>>
>> This doesn't seem to be true though. I really would love for 
>> there
>> to be a way to influence the link description, but no matter 
>> what
>> the documentation should be corrected.
>>
>> For some more info look at
>> https://www.reddit.com/r/orgmode/comments/xmvtsy/orgcreatefilesearchfunctions_and_description/
>
> Thanks for reporting!
> Confirmed.
>
> This is a regression after we switched to lexical binding, and 
> after we
> removed the apparently uninitialized `description' variable from
> let-binding in `org-store-link'.
>
>     a85b4cc5c64b1eb6b97f5d7843dd54eb0632ef91
>     Author:     Stefan Monnier <monnier@iro.umontreal.ca>
>     AuthorDate: Thu Mar 11 13:07:37 2021 -0500
>     Commit:     Kyle Meyer <kyle@kyleam.com>
>     CommitDate: Sun Mar 14 17:54:17 2021 -0400
>
>     Backport commit 7d0dc3183 from Emacs
>
>     ...
>     * lisp/ol.el (org-store-link):
>     Remove always-nil variable `description`.
>
> In order to make things work now with lexical binding, we need 
> to create
> a top-level defvar in ol.el, which is not nice since 
> `description'
> variable name is a bad name to define.
>
> Interestingly, this issue has not been noticed for a long time 
> and not
> many users are probably making use of it.
>
> Thus, we may as well take this opportunity and allow
> `org-create-file-search-functions' to return a cons cell
> ("search term" . "description"). This will not require 
> unintuitive
> global variables.
>
> WDYT?

I think returning a cons cell would be a very nice solution.

/M

--
Magnus Therning                   OpenPGP: 0x927912051716CE39
email: magnus@therning.org
@magthe@mastodon.technology       http://magnus.therning.org/

Never argue with stupid people, they will drag you down to their 
level
and then beat you with experience.
     ― Mark Twain

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 861 bytes --]

  reply	other threads:[~2022-09-26 12:34 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-25 17:40 [BUG] org-create-file-search-functions and description [9.5.5 (release_9.5.5 @ /usr/share/emacs/29.0.50/lisp/org/)] Magnus Therning
2022-09-26 12:12 ` Ihor Radchenko
2022-09-26 12:15   ` Magnus Therning [this message]
2022-09-26 15:13   ` Max Nikulin
2022-09-27  1:35     ` Ihor Radchenko
2022-09-27  1:40     ` [BUG] org-store-link-functions advertizes that the first non-nil return value is used, but it is not how org-store-link handles it (was: [BUG] org-create-file-search-functions and description [9.5.5 (release_9.5.5 @ /usr/share/emacs/29.0.50/lisp/org/)]) Ihor Radchenko
2022-09-27 11:39       ` [BUG] org-store-link-functions advertizes that the first non-nil return value is used, but it is not how org-store-link handles it Max Nikulin
2022-09-28  1:03         ` Ihor Radchenko

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=871qryba4z.fsf@therning.org \
    --to=magnus@therning.org \
    --cc=emacs-orgmode@gnu.org \
    --cc=yantar92@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 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).