From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Paul Eggert Newsgroups: gmane.emacs.devel Subject: Re: Refactoring in rst.el Date: Sat, 7 Jan 2017 09:18:52 -0800 Organization: UCLA Computer Science Department Message-ID: <95b7096e-9a9d-f0c9-54b4-9f7850ca676c@cs.ucla.edu> References: <492.1483523991@eskebo.fritz.box> <4331.1483545171@eskebo.fritz.box> <28fe59fd-191f-64c0-2333-7462403d976c@cs.ucla.edu> <19306.1483785955@eskebo.fritz.box> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit X-Trace: blaine.gmane.org 1483809584 30028 195.159.176.226 (7 Jan 2017 17:19:44 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sat, 7 Jan 2017 17:19:44 +0000 (UTC) User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:45.0) Gecko/20100101 Thunderbird/45.5.1 Cc: Kaushal Modi , Emacs Development , Tino Calancha To: Stefan Merten Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Jan 07 18:19:38 2017 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by blaine.gmane.org with esmtp (Exim 4.84_2) (envelope-from ) id 1cPueW-0006DH-22 for ged-emacs-devel@m.gmane.org; Sat, 07 Jan 2017 18:19:36 +0100 Original-Received: from localhost ([::1]:58508 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cPueX-0003QY-DC for ged-emacs-devel@m.gmane.org; Sat, 07 Jan 2017 12:19:37 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:41258) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cPudx-0003PL-VG for Emacs-devel@gnu.org; Sat, 07 Jan 2017 12:19:02 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cPudt-0008UE-Vm for Emacs-devel@gnu.org; Sat, 07 Jan 2017 12:19:01 -0500 Original-Received: from zimbra.cs.ucla.edu ([131.179.128.68]:54772) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1cPudt-0008Tt-Ox for Emacs-devel@gnu.org; Sat, 07 Jan 2017 12:18:57 -0500 Original-Received: from localhost (localhost [127.0.0.1]) by zimbra.cs.ucla.edu (Postfix) with ESMTP id 4305916007F; Sat, 7 Jan 2017 09:18:56 -0800 (PST) Original-Received: from zimbra.cs.ucla.edu ([127.0.0.1]) by localhost (zimbra.cs.ucla.edu [127.0.0.1]) (amavisd-new, port 10032) with ESMTP id thUJ9tl6zSy2; Sat, 7 Jan 2017 09:18:55 -0800 (PST) Original-Received: from localhost (localhost [127.0.0.1]) by zimbra.cs.ucla.edu (Postfix) with ESMTP id 844B2160084; Sat, 7 Jan 2017 09:18:55 -0800 (PST) X-Virus-Scanned: amavisd-new at zimbra.cs.ucla.edu Original-Received: from zimbra.cs.ucla.edu ([127.0.0.1]) by localhost (zimbra.cs.ucla.edu [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id Lu1IighHrH6B; Sat, 7 Jan 2017 09:18:55 -0800 (PST) Original-Received: from [192.168.1.9] (unknown [47.153.178.162]) by zimbra.cs.ucla.edu (Postfix) with ESMTPSA id 5CC1516007F; Sat, 7 Jan 2017 09:18:55 -0800 (PST) In-Reply-To: <19306.1483785955@eskebo.fritz.box> X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x [fuzzy] X-Received-From: 131.179.128.68 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: "Emacs development discussions." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Original-Sender: "Emacs-devel" Xref: news.gmane.org gmane.emacs.devel:211154 Archived-At: 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.