all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Paul Eggert <eggert@cs.ucla.edu>
To: Stefan Merten <stefan@merten-home.de>
Cc: Kaushal Modi <kaushal.modi@gmail.com>,
	Emacs Development <Emacs-devel@gnu.org>,
	Tino Calancha <tino.calancha@gmail.com>
Subject: Re: Refactoring in rst.el
Date: Sat, 7 Jan 2017 09:18:52 -0800	[thread overview]
Message-ID: <95b7096e-9a9d-f0c9-54b4-9f7850ca676c@cs.ucla.edu> (raw)
In-Reply-To: <19306.1483785955@eskebo.fritz.box>

Stefan Merten wrote:

> Which raises the question what the API of `rst.el` is.

When in doubt, document the change in the ChangeLog.

> I remember
> that in Emacs you started using a double dash in identifiers to mark
> them private.

Yes. The part in front of the double-dash is the module name.

> If so, I'd probably like to mark internal functions this way. That
> would be a good idea IMHO.

Yes, that's a reasonable change. It'd be a change to the API, and should be 
documented in the ChangeLog and in any other documentation to the package.

After that happens, it's a good idea to document even changes to the internal 
API, for benefit of those maintaining the code in question.



  reply	other threads:[~2017-01-07 17:18 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-01-04  2:27 [Emacs-diffs] master 9ed3685a77: Lots of refactorings and a few minor improvements Tino Calancha
2017-01-04  3:05 ` Paul Eggert
2017-01-04 13:56   ` Kaushal Modi
     [not found] ` <492.1483523991@eskebo.fritz.box>
     [not found]   ` <4331.1483545171@eskebo.fritz.box>
2017-01-04 18:23     ` Paul Eggert
2017-01-07 10:45       ` Refactoring in rst.el (was: Re: [Emacs-diffs] master 9ed3685a77: Lots of refactorings and a few minor improvements.) Stefan Merten
2017-01-07 17:18         ` Paul Eggert [this message]
2017-01-14 15:18           ` Refactoring in rst.el Stefan Merten

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=95b7096e-9a9d-f0c9-54b4-9f7850ca676c@cs.ucla.edu \
    --to=eggert@cs.ucla.edu \
    --cc=Emacs-devel@gnu.org \
    --cc=kaushal.modi@gmail.com \
    --cc=stefan@merten-home.de \
    --cc=tino.calancha@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 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.