From: Andreas Enge <andreas@enge.fr>
To: Mathieu Lirzin <mthl@gnu.org>
Cc: guix-devel@gnu.org
Subject: Re: 01/01: doc: Typos and small stylistic changes.
Date: Sun, 6 Mar 2016 16:26:46 +0100 [thread overview]
Message-ID: <20160306152646.GA16301@solar> (raw)
In-Reply-To: <87fuw3d8ip.fsf@gnu.org>
On Sun, Mar 06, 2016 at 02:46:06PM +0100, Mathieu Lirzin wrote:
> It is painful but necessary:
> https://www.gnu.org/prep/standards/html_node/Doc-Strings-and-Manuals.html#Doc-Strings-and-Manuals
> A way to understand why this is important is to read some of the
> "documentation" used by the Java APIs.
I agree. However, here we _do_ copy verbatim docstrings from the source code
into the manual, which is also fine. And then we are expected to back-port
changes to the supposedly manually written manual :-) back to the docstrings.
So it would be nice if there were a system to just include selected
docstrings; a texinfo command @docstring{guix-service-type} or something like
that. But I think it does not exist.
Andreas
next prev parent reply other threads:[~2016-03-06 15:26 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <20160305152745.10002.35086@vcs.savannah.gnu.org>
[not found] ` <E1acE7O-0002cK-0Z@vcs.savannah.gnu.org>
2016-03-05 21:48 ` 01/01: doc: Typos and small stylistic changes Ludovic Courtès
2016-03-06 13:10 ` Andreas Enge
2016-03-06 13:46 ` Mathieu Lirzin
2016-03-06 15:26 ` Andreas Enge [this message]
2016-03-06 19:13 ` Mathieu Lirzin
2016-03-06 23:10 ` Ludovic Courtès
2016-03-06 16:02 ` Andreas Enge
2016-03-09 9:02 ` Alex Kost
2016-03-11 14:19 ` Ludovic Courtès
2016-03-14 19:58 ` Andreas Enge
2016-03-15 16:20 ` Ludovic Courtès
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=20160306152646.GA16301@solar \
--to=andreas@enge.fr \
--cc=guix-devel@gnu.org \
--cc=mthl@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).