From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Stephen Leake Newsgroups: gmane.emacs.devel Subject: Re: Separating obarray handling from abbrevs Date: Mon, 09 Nov 2015 03:38:39 -0600 Message-ID: <86r3jza4ww.fsf@stephe-leake.org> References: <87d1vvfa1k.fsf@cumego.com> <87r3k95ppo.fsf@cumego.com> <87mvuomik1.fsf@cumego.com> <87bnb4nqvz.fsf@gmail.com> <87lha8jimn.fsf@cumego.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable X-Trace: ger.gmane.org 1447062002 8009 80.91.229.3 (9 Nov 2015 09:40:02 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Mon, 9 Nov 2015 09:40:02 +0000 (UTC) Cc: Artur Malabarba , Emacs Developers To: =?utf-8?Q?Przemys=C5=82aw?= Wojnowski Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Mon Nov 09 10:39:46 2015 Return-path: Envelope-to: ged-emacs-devel@m.gmane.org Original-Received: from lists.gnu.org ([208.118.235.17]) by plane.gmane.org with esmtp (Exim 4.69) (envelope-from ) id 1ZvivR-0004y4-IC for ged-emacs-devel@m.gmane.org; Mon, 09 Nov 2015 10:39:46 +0100 Original-Received: from localhost ([::1]:51209 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1ZvivR-00069c-3p for ged-emacs-devel@m.gmane.org; Mon, 09 Nov 2015 04:39:45 -0500 Original-Received: from eggs.gnu.org ([2001:4830:134:3::10]:48828) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Zviuk-0005LG-QD for emacs-devel@gnu.org; Mon, 09 Nov 2015 04:39:03 -0500 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Zviuf-0007Wi-T1 for emacs-devel@gnu.org; Mon, 09 Nov 2015 04:39:02 -0500 Original-Received: from gproxy1-pub.mail.unifiedlayer.com ([69.89.25.95]:54073) by eggs.gnu.org with smtp (Exim 4.71) (envelope-from ) id 1Zviuf-0007UI-Lj for emacs-devel@gnu.org; Mon, 09 Nov 2015 04:38:57 -0500 Original-Received: (qmail 31511 invoked by uid 0); 9 Nov 2015 09:38:52 -0000 Original-Received: from unknown (HELO cmgw3) (10.0.90.84) by gproxy1.mail.unifiedlayer.com with SMTP; 9 Nov 2015 09:38:52 -0000 Original-Received: from host114.hostmonster.com ([74.220.207.114]) by cmgw3 with id fUeh1r00U2UdiVW01Uekvw; Mon, 09 Nov 2015 09:38:50 -0700 X-Authority-Analysis: v=2.1 cv=Caqbutbl c=1 sm=1 tr=0 a=CQdxDb2CKd3SRg4I0/XZPQ==:117 a=CQdxDb2CKd3SRg4I0/XZPQ==:17 a=DsvgjBjRAAAA:8 a=f5113yIGAAAA:8 a=9i_RQKNPAAAA:8 a=IkcTkHD0fZMA:10 a=hEr_IkYJT6EA:10 a=x_XPkuGwIRMA:10 a=qtqOOiqGOCEA:10 a=ttMgCLtsAAAA:8 a=pGLkceISAAAA:8 a=qnarx3HFaa7y88IC_84A:9 a=QEXdDO2ut3YA:10 Original-Received: from [76.218.37.33] (port=52464 helo=TAKVER2) by host114.hostmonster.com with esmtpa (Exim 4.84) (envelope-from ) id 1ZviuR-0000xS-EJ; Mon, 09 Nov 2015 02:38:43 -0700 In-Reply-To: <87lha8jimn.fsf@cumego.com> (=?utf-8?Q?=22Przemys=C5=82aw?= Wojnowski"'s message of "Sun, 08 Nov 2015 22:17:36 +0100") User-Agent: Gnus/5.13 (Gnus v5.13) Emacs/24.5 (windows-nt) X-Identified-User: {2442:host114.hostmonster.com:stephele:stephe-leake.org} {sentby:smtp auth 76.218.37.33 authed with stephen_leake@stephe-leake.org} X-detected-operating-system: by eggs.gnu.org: GNU/Linux 3.x X-Received-From: 69.89.25.95 X-BeenThere: emacs-devel@gnu.org X-Mailman-Version: 2.1.14 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-bounces+ged-emacs-devel=m.gmane.org@gnu.org Xref: news.gmane.org gmane.emacs.devel:193696 Archived-At: Przemys=C5=82aw Wojnowski writes: > Artur Malabarba writes: > >>> +(defun obarray-make (&optional size) >>> + "Return a new obarray of size `SIZE' or `obarray-default-size'." >> >> Use SIZE, not `SIZE'. Similarly everywhere else. The markup for arguments (like "size") is all caps. The markup for other variables/defuns (like "obarray-default-size") is quotes. >>> +(defun obarray-get (obarray name) >>> + "Return from obarray `OBARRAY' symbol with `NAME' or nil." >> >> I'd use: >> "Return symbol named NAME if it is contained in OBARRAY. >> Return nil otherwise." >> >> And I would repeat this throughout the docstrings. > Will do that. Then you have to ignore complaints from the comment style checker, which insists on listing the arguments in order in the doc string. There was a proposal recently to delete that check. --=20 -- Stephe