[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Refactoring in rst.el

From: Paul Eggert
Subject: Re: Refactoring in rst.el
Date: Sat, 7 Jan 2017 09:18:52 -0800
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.5.1

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 via email to

[Prev in Thread] Current Thread [Next in Thread]