From mboxrd@z Thu Jan 1 00:00:00 1970 From: swedebugia Subject: Re: Missing code comments in guix source: 2 examples from gnu/services Date: Mon, 5 Nov 2018 10:14:14 +0100 Message-ID: <3cb4b880-668a-5501-8f22-58d7c452c1a5@riseup.net> References: <427b45c9-f2c6-1394-c5e6-aecf3e30570b@riseup.net> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="------------1D037D36BE49AE5FEAEDA310" Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:60650) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1gJaxx-0003TL-8C for guix-devel@gnu.org; Mon, 05 Nov 2018 04:14:40 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1gJaxj-0004SH-5i for guix-devel@gnu.org; Mon, 05 Nov 2018 04:14:28 -0500 Received: from mx1.riseup.net ([198.252.153.129]:49855) by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32) (Exim 4.71) (envelope-from ) id 1gJaxi-0003Ku-H6 for guix-devel@gnu.org; Mon, 05 Nov 2018 04:14:22 -0500 In-Reply-To: Content-Language: en-US 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?= , guix-devel@gnu.org This is a multi-part message in MIME format. --------------1D037D36BE49AE5FEAEDA310 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: quoted-printable Hi Thanks for the quick reply :) On 2018-11-05 09:40, G=C3=A1bor Boskovits wrote: > Hello, > > swedebugia ezt =C3=ADrta (id=C5=91p= ont: 2018. nov.=20 5., > H, 9:33): >> >> >> prometheus-node-exporter-shepherd-service is=20 just as little >> documented in the same file. From the file I have no=20 idea what this >> does as its only documentation is: >> >>=20 (shepherd-service (documentation "Prometheus node exporter.") >> >> ---=20 >> > > Thanks for pointing this out, I will fix this in >=20 prometheus-node-exporter. Thank you :) > > Can you point me to a service where the documentation is >=20 statisfactory? Actually I cannot yet as I have only read these two files. I will get=20 back to you on that one. I'm going to install geiser to try the autodoc function, but if I=20 understood correctly this only works with docstrings, NOT say package=20 records. Do we have a tool in emacs/geiser for looking up a package synopsis=20 based on the package-name at point? Anyway when printing on paper and reading via a git client/git web this=20 won't help. --=20 Cheers Swedebugia --------------1D037D36BE49AE5FEAEDA310 Content-Type: text/html; charset=utf-8 Content-Transfer-Encoding: quoted-printable

Hi

Thanks for the quick reply :)


On 2018-11-05 09:40, G=C3=A1bor Boskovits wrote:
&= gt; Hello, >=20 > swedebugia <swedebugia@riseup.net> ezt =C3=ADrta (id=C5=91= pont: 2018. nov. 5., > H, 9:33): >>=20 >>=20 >> prometheus-node-exporter-shepherd-service is just as little >> documented in the same file. From the file I have no idea what t= his >> does as its only documentation is: >>=20 >> (shepherd-service (documentation "Prometheus node exporter.") >>=20 >> --- >>=20 >=20 > Thanks for pointing this out, I will fix this in > prometheus-node-exporter. Thank you :)
&= gt;=20 > Can you point me to a service where the documentation is > statisfactory?

Actually I cannot yet as I have only read these two files. I will get back to you on that one.

I'm going to install geiser to try the autodoc function, but if I understood correctly this only works with docstrings, NOT say package records.

Do we have a tool in emacs/geiser for looking up a package synopsis based on the package-name at point?

Anyway when printing on paper and reading via a git client/git web this won't help.

--
Cheers
Swedebugia

--------------1D037D36BE49AE5FEAEDA310--