From mboxrd@z Thu Jan 1 00:00:00 1970 From: ludo@gnu.org (Ludovic =?utf-8?Q?Court=C3=A8s?=) Subject: Re: Missing code comments in guix source: 2 examples from gnu/services Date: Tue, 06 Nov 2018 15:15:09 +0100 Message-ID: <87k1lq1edu.fsf@gnu.org> References: <427b45c9-f2c6-1394-c5e6-aecf3e30570b@riseup.net> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:46629) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gK28e-0001lp-K9 for guix-devel@gnu.org; Tue, 06 Nov 2018 09:15:34 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gK28M-0001fL-SD for guix-devel@gnu.org; Tue, 06 Nov 2018 09:15:15 -0500 In-Reply-To: (=?utf-8?Q?=22G=C3=A1bor?= Boskovits"'s message of "Mon, 5 Nov 2018 09:40:04 +0100") 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: =?utf-8?Q?G=C3=A1bor?= Boskovits Cc: Guix-devel Hi, G=C3=A1bor Boskovits skribis: > swedebugia ezt =C3=ADrta (id=C5=91pont: 2018. nov= . 5., H, 9:33): [...] >> prometheus-node-exporter-shepherd-service is just as little documented i= n the same file. From the file I have no idea what this does as its only do= cumentation is: >> >> (shepherd-service >> (documentation "Prometheus node exporter.") >> >> --- >> > > Thanks for pointing this out, I will fix this in prometheus-node-exporter. > Can you point me to a service where the documentation is statisfactory? Note that the =E2=80=98documentation=E2=80=99 field that you see above is w= hat =E2=80=9Cherd doc prometheus-node-exporter=E2=80=9D shows. It should be terse compared to the =E2=80=98documentation=E2=80=99 field of =E2=80=98service-type=E2=80=99. Thanks, Ludo=E2=80=99.