all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: "Paul W. Rankin" <hello@paulwrankin.com>
To: Tassilo Horn <tsdh@gnu.org>
Cc: Help Gnu Emacs mailing list <help-gnu-emacs@gnu.org>
Subject: Re: Understanding internal use functions
Date: Tue, 07 May 2019 13:07:47 +1000	[thread overview]
Message-ID: <m2ftprezcs.fsf@paulwrankin.com> (raw)
In-Reply-To: <87imuoghwv.fsf@gnu.org>


On Mon, May 06 2019, Tassilo Horn wrote:
>> It seems easier for internal use variables; if the user changes the
>> `this--internal-variable' then the program may not work. Functions
>> leave me a bit more bewildered... Or should I just think of it in the
>> same way, e.g. "don't run this function yourself or you'll break
>> things"?
>
> This applies to any function or variable, e.g., activate lisp-mode (a
> command) in a JavaScript file, or set auto-mode-alist to "Hello 
> world".
> That just doesn't make sense and won't work but of course they are
> non-internal nevertheless.
>
> Internal functions/variables usually convey the meaning of "don't rely
> on me because I might change whenever my author likes".  So it's more 
> a
> hint to programmers than to users.

So I should name a functions as internal as a way to imply "hey don't 
use this in other programs" (for whatever reason)?

-- 
https://www.paulwrankin.com



  reply	other threads:[~2019-05-07  3:07 UTC|newest]

Thread overview: 4+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-06  4:15 Understanding internal use functions Paul W. Rankin
2019-05-06  7:29 ` Tassilo Horn
2019-05-07  3:07   ` Paul W. Rankin [this message]
2019-05-07  9:57     ` Tassilo Horn

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=m2ftprezcs.fsf@paulwrankin.com \
    --to=hello@paulwrankin.com \
    --cc=help-gnu-emacs@gnu.org \
    --cc=tsdh@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 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.