From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED!not-for-mail From: Stefan Merten Newsgroups: gmane.emacs.devel Subject: Refactoring in rst.el (was: Re: [Emacs-diffs] master 9ed3685a77: Lots of refactorings and a few minor improvements.) Date: Sat, 07 Jan 2017 11:45:55 +0100 Message-ID: <19306.1483785955@eskebo.fritz.box> References: <492.1483523991@eskebo.fritz.box> <4331.1483545171@eskebo.fritz.box> <28fe59fd-191f-64c0-2333-7462403d976c@cs.ucla.edu> NNTP-Posting-Host: blaine.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: quoted-printable X-Trace: blaine.gmane.org 1483786021 3212 195.159.176.226 (7 Jan 2017 10:47:01 GMT) X-Complaints-To: usenet@blaine.gmane.org NNTP-Posting-Date: Sat, 7 Jan 2017 10:47:01 +0000 (UTC) Cc: Kaushal Modi , Emacs Development , Tino Calancha To: Paul Eggert Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Sat Jan 07 11:46:56 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 1cPoWQ-0007k8-Hr for ged-emacs-devel@m.gmane.org; Sat, 07 Jan 2017 11:46:50 +0100 Original-Received: from localhost ([::1]:57114 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cPoWT-0007tL-5r for ged-emacs-devel@m.gmane.org; Sat, 07 Jan 2017 05:46:53 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:52286) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cPoVu-0007tA-Sn for Emacs-devel@gnu.org; Sat, 07 Jan 2017 05:46:19 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cPoVo-0007R8-Jt for Emacs-devel@gnu.org; Sat, 07 Jan 2017 05:46:18 -0500 Original-Received: from mout.kundenserver.de ([217.72.192.74]:64876) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1cPoVo-0007Qp-9O for Emacs-devel@gnu.org; Sat, 07 Jan 2017 05:46:12 -0500 Original-Received: from eskebo.homelinux.merten-home.de ([94.222.143.176]) by mrelayeu.kundenserver.de (mreue103 [212.227.15.145]) with ESMTPSA (Nemesis) id 0LvQBP-1cZGRK2083-010gBX; Sat, 07 Jan 2017 11:45:57 +0100 Original-Received: by eskebo.homelinux.merten-home.de (Postfix, from userid 1000) id 86580C0135; Sat, 7 Jan 2017 11:45:55 +0100 (CET) In-reply-to: <28fe59fd-191f-64c0-2333-7462403d976c@cs.ucla.edu> Comments: In-reply-to Paul Eggert message dated "Wed, 04 Jan 2017 10:23:10 -0800." X-Mailer: MH-E 8.6; nmh 1.6; GNU Emacs 24.5.1 X-Provags-ID: V03:K0:3Hnd9j/QZWXUCNGPleqrfDUm+ile2AJ4ZexEhPd2uaTvcWEb7PW 28JRz7z0/RbpoUI3V1QDH4uVTMG5QZ3cQdfmxu2/s7sIuLz+iBSj5doqVBBGVApkkZdhWU9 rrJ46u6BDthqZB6LP06tJFjjmukDFNBuYWeMtQPjVixFqZbVWmSwDlG4TIoszi8TmXyDBli z2tb7qVnU2TADlqcu1fDw== X-UI-Out-Filterresults: notjunk:1;V01:K0:A71u7IUxZoo=:dAeSGQ8vtn//ccyyGNl0w5 Z3+UdXBFw4f0MzIreYxzxeLA+1Sl3C8xl/f4xTdauNrSQrPL7881oaCN3h7wrR33Bgunc1FbP xDaL65JVuK+w3X5m6yIJM25NMpMoeeJTETFW+n4g4WY9RE6PtQNpp4lizBWUBY+D0C+x5NyTU Ifd0AB3C/ZiviJXOmWrpGDwwjzfRAsdLQgQiNJDDh26UxlOmVxU+H6soxU/Un/jnWJYUU4S+C pOOjq0HEA0GeshDm4fBqAlpjrWnIhd3aJ5Vn2lYsVCgkUqGZyQ+RD7d86Ekv0RT6jAA4zs2ja 4pnwKCiwmhuL6o49Zczji0Q625iZFoKi6NyOXyAUNBFSAs2n4vM011Vto+ySzwm/YG4Gx2rbI z5UqtiofaMP28b6Q/7SIk/4e9kLSGymt+XbbYEjDGTHJYuruiskaFox44YApCzGssgD0GhZTw 59B9Vrd4ze0g6T7vSw4wVJJDNHpdfdkeKNCC5817qCQb1lS1AMmTXfuIB/wqFn29qIgL5dvwE QuDqG/JcQhiDw8RBSE/y2WsPtKDeuGuu231lB0Wlvnd9KCyiiVvKUciJ427PcKyAjE+2G0ryl /xWNaOefagJoxa6/bMfCEipTOSLYgNF2jYxx3fXipDc6KIlH6ZF5g35kBg8im2VIPzOPIupvR HO9sjlXIkAiMKlkChYyCfLOzDOvHBxlSQ4KVXAnReQ705KgnTTjxrdenf+nATOJNXsKR3xiZ0 DBL6Neh3CqH49Xyd X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] [fuzzy] X-Received-From: 217.72.192.74 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:211152 Archived-At: Hi Paul! 3 days ago Paul Eggert wrote: > Stefan Merten wrote: >> I got the impression, that lately few people care about these rules >=20 > I'm afraid that impression is incorrect. Many developers care (hence > this thread :-). Thanks for reassuring. As you can see in the log I once did care but this time thought it is no longer worth the hassle. >> I hope the commit message below is what you require. >=20 > Much better, thanks. My main problem with it is that "Refactor by > removing old functions, introducing new functions and change existing > functions" is too vague. Please write for an audience that includes > people who have code that calls (say) rst-comment-region and want to > know how to adjust the code after your changes to the API. Which raises the question what the API of `rst.el` is. So far I was convinced that nobody will use any function from `rst.el` - so I'd think that nobody is impacted by refactoring even if I change signatures of functions. Of course I may be wrong. Apart from that I'd think the interactive functions are the *real* interface of `rst.el` which is interesting. Refactoring, however, by definition does not impact this behavior. Debugging and those minor changes in behavior which I did during refactoring I did document, however. Where key bindings are impacted I defined aliases for renamed functions so older key bindings should continue to work. In other languages you have this public / private concept. I remember that in Emacs you started using a double dash in identifiers to mark them private. For example rst-comment-region would be part of the public interface, while rst--comment-region would be an internal function not meant for public use. Is that correct? Are the examples valid? If so, I'd probably like to mark internal functions this way. That would be a good idea IMHO. Gr=FC=DFe Stefan