From: Christian Miller <christian.miller@mail.dadoes.de>
To: Matt <matt@excalamus.com>, guix-devel <guix-devel@gnu.org>
Cc: Christian Miller <christian.miller@dadoes.de>,
pelzflorian <pelzflorian@pelzflorian.de>,
maximcournoyer <maxim.cournoyer@gmail.com>, dev <dev@jpoiret.xyz>
Subject: Re: Fix grammar and markup (was Re: Feedback of the GNU Guix manual)
Date: Thu, 11 Apr 2024 14:59:03 +0200 [thread overview]
Message-ID: <d23915c2-11e4-46ce-aa66-021c69d3e73c@mail.dadoes.de> (raw)
In-Reply-To: <18ec853a933.df0e6c395339428.1434045801453734872@excalamus.com>
Hello,
I just want to mention that I am still in CC and my mail server is going
offline. Need to optimize my budget and don't have any time for GNU
anymore because of university.
--
Christian Miller
Am 10/04/2024 um 16:05 schrieb Matt:
> We're working through a list of feedback one item at a time:
> https://lists.gnu.org/archive/html/guix-devel/2024-01/msg00117.html
>
> We have completed the first two items.
>
> The next item reported is:
>
> #+begin_quote
> 2.4 Setting up the deamon
>
> Seems like an issue with info. Have seen this in the Emacs manual as well. There is also sometimes see see (doc)
>
> L15 See also see Substitutes.
> #+end_quote
>
> This sounds like the use of an @xref instead of @ref. However, I can't find it in the current version (5a95cf76) of the documentation, nor the reported version (ee7c9d25). The last change to doc/guix.texi at that the reported time was in e5ed1712 (git log -n 1 ee7c9d25 -- doc/guix.texi).
>
> The full reported sentence currently reads,
>
> #+begin_quote
> See also @ref{Substitutes}, for information on how to allow the daemon to download pre-built binaries.
> #+end_quote
>
> The use of the comma after "Substitutes" is inappropriate, if I have the terminology correct, because "See also Substitutes" is not a participial phrase. "Also" and "information on" are also unnecessary. I suggest the following:
>
> #+begin_quote
> See @ref{Substitutes} for how to allow the daemon to download pre-built binaries.
> #+end_quote
>
> Searching for "see also" turns up the following in 'Mail Services':
>
> #+begin_quote
> See also ssl=required setting.
> #+end_quote
>
> This needs "the" before "ssl=required" as it refers to a specific setting. It should probably use the @option or @samp markup:
>
> #+begin_quote
> See also the @samp{ssl=required} setting.
> #+end_quote
>
> I have opted for @samp because it's used elsewhere for similar items. In the same section is:
>
> #+begin_quote
> NOTE: See also @samp{disable-plaintext-auth} setting.
> #+end_quote
>
> This too should have "the" before the setting. The "NOTE:" designation is also unnecessary. I suggest:
>
> #+begin_quote
> See also the @samp{disable-plaintext-auth} setting.
> #+end_quote
>
> Included is a patch which makes these suggested changes.
>
> It was advised to submit the previous patch to guix-patches. I opted to submit this next patch here to keep the thread connected since it's part of a larger discussion (I suppose). If we're agreed that guix-patches is more appropriate, I can submit the next item in a new thread there using the same message format I've been following. Thoughts?
next prev parent reply other threads:[~2024-04-13 23:16 UTC|newest]
Thread overview: 59+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-14 15:01 Feedback of the GNU Guix manual Christian Miller
2024-01-15 17:52 ` Matt
2024-01-15 22:05 ` Christian Miller
2024-01-18 19:44 ` Maxim Cournoyer
2024-01-19 21:01 ` Matt
2024-01-26 23:59 ` Matt
2024-02-18 12:35 ` Matt
2024-02-18 13:55 ` Josselin Poiret
2024-02-21 18:27 ` Matt
2024-02-21 17:20 ` Maxim Cournoyer
2024-02-21 18:36 ` Matt
2024-02-23 2:46 ` Maxim Cournoyer
2024-02-23 18:37 ` Matt
2024-03-02 13:34 ` Matt
2024-03-06 17:15 ` doc: Removing much of Binary Installation (was: Feedback of the GNU Guix manual) pelzflorian (Florian Pelz)
2024-03-06 19:42 ` Matt
2024-03-06 20:52 ` doc: Removing much of Binary Installation Suhail Singh
2024-03-06 21:18 ` Suhail Singh
2024-03-07 17:03 ` pelzflorian (Florian Pelz)
2024-03-10 11:09 ` doc: installation: fix ~root confusion (was Re: doc: Removing much of Binary Installation) Matt
2024-03-10 20:42 ` Vagrant Cascadian
2024-03-10 23:21 ` Suhail Singh
2024-03-11 1:58 ` Vagrant Cascadian
2024-03-11 4:27 ` John Kehayias
2024-03-11 19:15 ` Vagrant Cascadian
2024-03-11 15:54 ` pelzflorian (Florian Pelz)
2024-03-16 10:47 ` Matt
2024-03-16 14:05 ` pelzflorian (Florian Pelz)
2024-03-17 17:34 ` Ludovic Courtès
2024-03-06 21:29 ` doc: Removing much of Binary Installation (was: Feedback of the GNU Guix manual) Vagrant Cascadian
2024-04-10 14:05 ` Fix grammar and markup (was " Matt
2024-04-11 12:59 ` Christian Miller [this message]
2024-04-12 14:41 ` pelzflorian (Florian Pelz)
2024-04-12 19:18 ` Matt
2024-04-13 12:02 ` pelzflorian (Florian Pelz)
2024-04-14 7:00 ` pelzflorian (Florian Pelz)
2024-04-19 14:09 ` Creating a documentation team? Ludovic Courtès
2024-04-19 15:32 ` Maxim Cournoyer
2024-04-19 17:32 ` pelzflorian (Florian Pelz)
2024-04-20 8:33 ` Matt
2024-05-01 20:34 ` Ludovic Courtès
2024-05-02 9:14 ` pelzflorian (Florian Pelz)
2024-04-12 20:16 ` Fix grammar and markup (was Re: Feedback of the GNU Guix manual) Ludovic Courtès
2024-04-13 8:22 ` Matt
2024-04-13 11:26 ` pelzflorian (Florian Pelz)
2024-04-14 14:50 ` Matt
2024-04-15 12:58 ` pelzflorian (Florian Pelz)
2024-04-15 18:39 ` Matt
2024-04-16 6:43 ` pelzflorian (Florian Pelz)
2024-04-18 17:15 ` Matt
2024-04-19 20:56 ` pelzflorian (Florian Pelz)
2024-04-20 8:36 ` Matt
2024-04-17 18:08 ` Maxim Cournoyer
2024-04-22 18:25 ` [PATCH] Fix typo (Re: " Matt
2024-04-22 22:43 ` pelzflorian (Florian Pelz)
2024-05-07 19:41 ` [PATCH] doc: Clarify need to update search paths on foreign distro (was " Matt
2024-05-07 20:41 ` Vagrant Cascadian
2024-05-10 9:57 ` Matt
2024-05-11 8:14 ` pelzflorian (Florian Pelz)
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=d23915c2-11e4-46ce-aa66-021c69d3e73c@mail.dadoes.de \
--to=christian.miller@mail.dadoes.de \
--cc=christian.miller@dadoes.de \
--cc=dev@jpoiret.xyz \
--cc=guix-devel@gnu.org \
--cc=matt@excalamus.com \
--cc=maxim.cournoyer@gmail.com \
--cc=pelzflorian@pelzflorian.de \
/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).