From mboxrd@z Thu Jan 1 00:00:00 1970 From: Tobias Geerinckx-Rice Subject: Re: packaging - sentences in description Date: Mon, 18 Mar 2019 15:54:28 +0100 Message-ID: <87lg1cs063.fsf@nckx> References: <87k1gwtfo5.fsf@roquette.mug.biscuolo.net> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([209.51.188.92]:57375) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1h5tew-00064b-5n for guix-devel@gnu.org; Mon, 18 Mar 2019 10:54:38 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1h5teu-0003oR-FV for guix-devel@gnu.org; Mon, 18 Mar 2019 10:54:38 -0400 Received: from tobias.gr ([2001:470:7405::1]:55886) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1h5ter-0003l4-IO for guix-devel@gnu.org; Mon, 18 Mar 2019 10:54:35 -0400 In-reply-to: <87k1gwtfo5.fsf@roquette.mug.biscuolo.net> List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+gcggd-guix-devel=m.gmane.org@gnu.org Sender: "Guix-devel" To: Giovanni Biscuolo Cc: guix-devel@gnu.org Giovanni Biscuolo wrote: > (description "Golang package for conveniently using named=20 > read/write > locks. These appear to be especially useful for synchronizing=20 > access to > session based information in web applications.=20 >=20=20=20 > The common use case is to use the package level functions, which=20 > use a package > level set of locks (safe to use from multiple goroutines > simultaneously). However, you may also create a new separate set=20 > of locks > test.=20 >=20=20=20 > All locks are implemented with read-write mutexes. To use them=20 > like a regular > mutex, simply ignore the RLock/RUnlock functions.") > (license license:public-domain)))) > --8<---------------cut=20 > here---------------end--------------->8--- > > it builds but when I check its description I get [1]: > > --8<---------------cut=20 > here---------------start------------->8--- > giovanni@anemone: time ./pre-inst-env guix lint -c description=20 > go-github-com-burntsushi-locker > gnu/packages/golang.scm:3202:19:=20 > go-github-com-burntsushi-locker@0.0.0-0.a6e239e: sentences in=20 > description should be followed by two spaces; possible=20 > infractions at 60, 329, 447 [=E2=80=A6] > --8<---------------cut=20 > here---------------end--------------->8--- > > I copy/pasted and adapted the description from the project=20 > homepage, > I'm using emacs and auto-fill mode on so it should have followed=20 > the > rules in .dir-locals.el These rules are for formatting Scheme code, they won't touch the=20 insides of strings. (Which isn't to say there isn't some M-x double-my-spaces=20 somewhere that I don't know of=E2=80=A6) > I can't understand where the sentences in my description lacks=20 > the two > required spaces: any hint please? Everywhere? :-p Instead. Of. Like. This. ^ ^ ^ We. Write. Like. This. ^^ ^^ ^^ > [1] it takes more than five minutes just for the description: I=20 > will > diligently do it for all my packages :-)... but it's a little=20 > bit > discouraging :-S I can sympathise, but it's not that much work compared to writing=20 code, and about as important. There will always be people who have never even heard of your=20 package, and there's nothing more frustrating than reading a 1( or=20 10)-line description and not learning a thing. Kind regards, T G-R