From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Glenn Morris Newsgroups: gmane.emacs.devel Subject: Re: [patch] Some fixes for flymake Date: Thu, 09 May 2013 21:20:27 -0400 Message-ID: References: <20130223220656.f500844733abd534265bd6f2@gmail.com> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=us-ascii X-Trace: ger.gmane.org 1368148835 26954 80.91.229.3 (10 May 2013 01:20:35 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Fri, 10 May 2013 01:20:35 +0000 (UTC) Cc: emacs-devel@gnu.org To: Xue Fuqiao Original-X-From: emacs-devel-bounces+ged-emacs-devel=m.gmane.org@gnu.org Fri May 10 03:20:34 2013 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 1Uac0g-0004Qu-4c for ged-emacs-devel@m.gmane.org; Fri, 10 May 2013 03:20:34 +0200 Original-Received: from localhost ([::1]:44565 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Uac0f-0002Kc-24 for ged-emacs-devel@m.gmane.org; Thu, 09 May 2013 21:20:33 -0400 Original-Received: from eggs.gnu.org ([208.118.235.92]:58238) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Uac0c-0002Jc-46 for emacs-devel@gnu.org; Thu, 09 May 2013 21:20:31 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1Uac0b-0006Xe-6Z for emacs-devel@gnu.org; Thu, 09 May 2013 21:20:30 -0400 Original-Received: from fencepost.gnu.org ([2001:4830:134:3::e]:42226) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1Uac0b-0006Xa-3n for emacs-devel@gnu.org; Thu, 09 May 2013 21:20:29 -0400 Original-Received: from rgm by fencepost.gnu.org with local (Exim 4.71) (envelope-from ) id 1Uac0a-0003Ps-80; Thu, 09 May 2013 21:20:28 -0400 X-Spook: terrorist secure rs9512c Ermes gamma CipherTAC-2000 Ft. X-Ran: +ThSY3.'J%/sf|sr*S|c\Boo+$H,WBoK]l'2HN{Q3AMkURC@{\]fB=SEEC3x (Xue Fuqiao's message of "Sat, 23 Feb 2013 22:06:56 +0800") User-Agent: Gnus (www.gnus.org), GNU Emacs (www.gnu.org/software/emacs/) X-detected-operating-system: by eggs.gnu.org: Error: Malformed IPv6 address (bad octet value). X-Received-From: 2001:4830:134:3::e 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:159460 Archived-At: Thanks. Looks mostly fine. Some comments follow, otherwise please install. - "Return the corresponding entry from `flymake-allowed-file-name-masks'." + "Return the function(s) correspond(s) to FILE-NAME in `flymake-allowed-file-name-masks'." The original is better (the new version is ungrammatical and looks too long). - (defun flymake-can-syntax-check-file (file-name) - "Determine whether we can syntax check FILE-NAME. - Return nil if we cannot, non-nil if we can." - (if (flymake-get-init-function file-name) t nil)) + (defun flymake-can-syntax-check-file (file-name) + "Determine whether we can syntax check FILE-NAME. + Return t if we can, nil if we cannot." + (if (flymake-get-init-function file-name) t nil)) I think the original is better, because the result seems to only ever be used in a Boolean sense. (I have no idea why this isn't just an alias to flymake-get-init-function... ) (defun flymake-find-possible-master-files (file-name master-file-dirs masks) - "Find (by name and location) all possible master files. + "Find (by FILE-NAME and MASTER-FILE-DIRS) all possible master files. I prefer the original. It may not slavishly follow what checkdoc says, but it is clearer. Add a separate explanation of what the arguments are if you want to. (defun flymake-check-include (source-file-name inc-name include-dirs) - "Check if SOURCE-FILE-NAME can be found in include path. + "Check if SOURCE-FILE-NAME can be found in INCLUDE-DIRS. As above. (defun flymake-save-buffer-in-file (file-name) + "Save the entire buffer contents into file FILE-NAME. + It also creates optionally any nonexistent parent directories." Better would be something like: "Create parent directories as needed." + ;; LocalWords: DIRS POS odl tex init GNUmakefile Makefile I don't think we want to add LocalWords to files? Not sure... The texi patch seems mainly (entirely?) to be changing from one space between sentences to two. That's fine. If there was any change apart from that, please point it out separately, otherwise please install.