From: Xinglu Chen <public@yoctocell.xyz>
To: Katherine Cox-Buday <cox.katherine.e@gmail.com>
Cc: guix-devel@gnu.org, Andrew Tropin <andrew@trop.in>
Subject: Re: Merging wip-guix-home to master
Date: Wed, 29 Sep 2021 17:02:18 +0200 [thread overview]
Message-ID: <87pmsr1l39.fsf@yoctocell.xyz> (raw)
In-Reply-To: <875yujqxhk.fsf@gmail.com>
[-- Attachment #1: Type: text/plain, Size: 887 bytes --]
On Wed, Sep 29 2021, Katherine Cox-Buday wrote:
> Xinglu Chen <public@yoctocell.xyz> writes:
>
>> I disagree, I think it’s OK for things like (guix git), which are mainly
>> used by developers, to not be documented in the manual.
>
> I strongly disagree with this. As a long-time developer, I have used
> documentation both as a user and as a developer many times.
>
> Documentation is for everyone.
I said “to not be documented in the manual” (the majority of (guix …)
modules aren’t documented in the manual); that doesn’t mean that there
aren’t any docstrings. The manual says that all top-level procedures
should have docstrings (see “16.5.4 Formatting Code”)
We require all top-level procedures to carry a docstring. This
requirement can be relaxed for simple private procedures in the ‘(guix
build ...)’ name space, though.
[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 861 bytes --]
next prev parent reply other threads:[~2021-09-29 15:05 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-09-23 9:53 Merging wip-guix-home to master Andrew Tropin
2021-09-23 15:27 ` Katherine Cox-Buday
2021-09-24 7:12 ` Andrew Tropin
2021-09-23 20:45 ` Ludovic Courtès
2021-09-24 7:43 ` Andrew Tropin
2021-09-24 13:38 ` Xinglu Chen
2021-09-28 10:14 ` Andrew Tropin
2021-09-29 11:39 ` Xinglu Chen
2021-09-29 14:15 ` Katherine Cox-Buday
2021-09-29 15:02 ` Xinglu Chen [this message]
2021-09-30 6:11 ` Andrew Tropin
2021-09-28 12:43 ` Ludovic Courtès
2021-09-28 15:23 ` Xinglu Chen
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
List information: https://guix.gnu.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87pmsr1l39.fsf@yoctocell.xyz \
--to=public@yoctocell.xyz \
--cc=andrew@trop.in \
--cc=cox.katherine.e@gmail.com \
--cc=guix-devel@gnu.org \
/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 public inbox
https://git.savannah.gnu.org/cgit/guix.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).