From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!not-for-mail From: Joost Kremers Newsgroups: gmane.emacs.help Subject: Re: "First line is not a complete sentence" (was: Re: Emacs conventions (was: Re: Overriding emacs key bindings)) Date: 18 May 2016 13:27:13 GMT Message-ID: References: <86k2iteg4e.fsf@student.uu.se> <87lh39h2hr.fsf@robertthorpeconsulting.com> <7ed720ce-0339-4de0-8f05-2f2ebbab3531@default> <867fesdtv4.fsf_-_@student.uu.se> <86eg90c53l.fsf@student.uu.se> NNTP-Posting-Host: plane.gmane.org Mime-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit X-Trace: ger.gmane.org 1464883140 11279 80.91.229.3 (2 Jun 2016 15:59:00 GMT) X-Complaints-To: usenet@ger.gmane.org NNTP-Posting-Date: Thu, 2 Jun 2016 15:59:00 +0000 (UTC) To: help-gnu-emacs@gnu.org Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Thu Jun 02 17:59:00 2016 Return-path: Envelope-to: geh-help-gnu-emacs@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 1b8V1J-0007OZ-Rh for geh-help-gnu-emacs@m.gmane.org; Thu, 02 Jun 2016 17:58:53 +0200 Original-Received: from localhost ([::1]:48184 helo=lists.gnu.org) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1b8V1J-0002q5-39 for geh-help-gnu-emacs@m.gmane.org; Thu, 02 Jun 2016 11:58:53 -0400 Original-Path: usenet.stanford.edu!fu-berlin.de!uni-berlin.de!individual.net!not-for-mail Original-Newsgroups: gnu.emacs.help Original-Lines: 31 Original-X-Trace: individual.net XotF1gJqI/h3C03uElE6LwffzA7WZwz4pq1Kjvx6VMGUt3ph+H Cancel-Lock: sha1:nYm9z4wu8bCU82wGV0qRWszuwc8= Mail-Copies-To: nobody X-Editor: Emacs of course! User-Agent: slrn/1.0.1 (Linux) Original-Xref: usenet.stanford.edu gnu.emacs.help:217791 X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.21 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "help-gnu-emacs" Xref: news.gmane.org gmane.emacs.help:110227 Archived-At: Emanuel Berg wrote: > But with docstrings, there is a wierd behavior > - often, this is the "error": > > First line is not a complete sentence > > What does that mean see (info "(elisp) Function Documentation"): ,---- | The first line of the documentation string should stand on its own, | because ‘apropos’ displays just this first line. It should consist of | one or two complete sentences that summarize the function’s purpose. `---- > and what is the definition > of a complete sentence - besides that it should > end with a full stop? Well, I suspect Emacs can only check whether it ends with a full stop, but the idea is of course also that it is a full sentence from a grammatical point of view. In essence, it should convey a clear and (in the given context) unambiguous message. -- Joost Kremers joostkremers@fastmail.fm Selbst in die Unterwelt dringt durch Spalten Licht EN:SiS(9)