emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Ihor Radchenko <yantar92@posteo.net>
To: Max Nikulin <manikulin@gmail.com>
Cc: emacs-orgmode@gnu.org
Subject: Re: Does variable 'org-goto-interface' exist?
Date: Wed, 14 Dec 2022 07:55:21 +0000	[thread overview]
Message-ID: <87359is9li.fsf@localhost> (raw)
In-Reply-To: <tna3c6$13no$2@ciao.gmane.io>

Max Nikulin <manikulin@gmail.com> writes:

> On 13/12/2022 18:43, Ihor Radchenko wrote:
>> +  Note: ~org-goto-*~ variables are only accessible when =org-goto=
>> +  library is loaded using ~require~ statement in the config or
>> +  auto-loaded by calling ~org-goto~ interactively.
>
> Perhaps it is better to introduce some more concise notation to specify 
> the package where a custom option or variable is defined like 
> ~org-goto-interface~ (=org-goto.el=).

I am not sure. This particular note is largely aiming at new users not
too familiar with Emacs system. Won't your suggestion be confusing?

For me ~org-goto-*~ should be naturally inside org-goto.el.

On the other hand, we may extend 1.5 Typesetting Conventions Used in
this Manual section of the manual describing what the proposed notation
refers to and then use it as needed.

Note, however, that org-goto is probably not the only place where we
refer to a customization that is not loaded by default. I am unsure how
many places like this exist and whether some presently auto-loaded
libraries will be still loaded in future as we try to make Org more
modular (and thus reduce the initial load time, many Emacs devs are
complaining about).

So, maintaining the proposed convention might not work well.

Or we may indicate the library with every variable we introduce from
that library for the first time + indicate that all the variables with
the same prefix will be from the same library.

WDYT?

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>


  reply	other threads:[~2022-12-14  8:20 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-12-13  8:54 Does variable 'org-goto-interface' exist? Alain.Cochard
2022-12-13  9:33 ` Ihor Radchenko
2022-12-13  9:51   ` Alain.Cochard
2022-12-13 11:43     ` Ihor Radchenko
2022-12-13 12:23       ` Alain.Cochard
2022-12-13 13:14         ` Ihor Radchenko
2022-12-17 18:22           ` [Info path] " Alain.Cochard
2022-12-13 14:48       ` Max Nikulin
2022-12-14  7:55         ` Ihor Radchenko [this message]
2022-12-14 10:00           ` Alain.Cochard
2022-12-14 10:48             ` Ihor Radchenko
2022-12-14 14:27           ` Max Nikulin
2022-12-15  9:02             ` Ihor Radchenko
2022-12-14 10:01 ` Max Nikulin
2022-12-14 10:20   ` Alain.Cochard
2022-12-14 14:20     ` Max Nikulin
2022-12-15  9:01       ` 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=87359is9li.fsf@localhost \
    --to=yantar92@posteo.net \
    --cc=emacs-orgmode@gnu.org \
    --cc=manikulin@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).