From: "Gábor Boskovits" <boskovits@gmail.com>
To: swedebugia@riseup.net
Cc: Guix-devel <guix-devel@gnu.org>
Subject: Re: Missing code comments in guix source: 2 examples from gnu/services
Date: Mon, 5 Nov 2018 09:40:04 +0100 [thread overview]
Message-ID: <CAE4v=piUQRm6aTFQKV2xiaxKpQs4=kUXVL54xUnkd0PnjAAfhw@mail.gmail.com> (raw)
In-Reply-To: <427b45c9-f2c6-1394-c5e6-aecf3e30570b@riseup.net>
Hello,
swedebugia <swedebugia@riseup.net> ezt írta (időpont: 2018. nov. 5., H, 9:33):
>
> Hi
>
> Reading this http://git.savannah.gnu.org/cgit/guix.git/tree/gnu/services/monitoring.scm
>
> I would like to know what darkstat is without having to look elsewhere.
>
> None of the (define-s have docstrings and the top comment
>
> ;;;
> ;;; darkstat
> ;;;
>
> does not help much.
>
> prometheus-node-exporter-shepherd-service is just as little documented in the same file. From the file I have no idea what this does as its only documentation 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?
> http://git.savannah.gnu.org/cgit/guix.git/tree/gnu/services/admin.scm
>
> Is generally a little better documented with docstrings. But here a header like
>
> ;;;
> ;;; darkstat
> ;;;
>
> is missing for rottlog and also a short description of what rottlog does. (from the name and peeking at the code I'm guessing it rotates logs but many services have arbitrary names, especially to newcomers on GNU/Linux)
>
> --
> Cheers
> Swedebugia
Best regards,
g_bor
next prev parent reply other threads:[~2018-11-05 8:52 UTC|newest]
Thread overview: 6+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-11-05 8:30 Missing code comments in guix source: 2 examples from gnu/services swedebugia
2018-11-05 8:40 ` Gábor Boskovits [this message]
2018-11-05 9:14 ` swedebugia
2018-11-05 10:39 ` Gábor Boskovits
2018-11-06 14:15 ` Ludovic Courtès
2018-11-08 23:12 ` swedebugia
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to='CAE4v=piUQRm6aTFQKV2xiaxKpQs4=kUXVL54xUnkd0PnjAAfhw@mail.gmail.com' \
--to=boskovits@gmail.com \
--cc=guix-devel@gnu.org \
--cc=swedebugia@riseup.net \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this external index
https://git.savannah.gnu.org/cgit/guix.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.