From: Matt <matt@excalamus.com>
To: "pelzflorian (Florian Pelz)" <pelzflorian@pelzflorian.de>
Cc: "\"Ludovic Courtès\"" <ludo@gnu.org>,
guix-devel <guix-devel@gnu.org>,
maximcournoyer <maxim.cournoyer@gmail.com>, dev <dev@jpoiret.xyz>
Subject: Re: Fix grammar and markup (was Re: Feedback of the GNU Guix manual)
Date: Sun, 14 Apr 2024 16:50:26 +0200 [thread overview]
Message-ID: <18edd168cf4.10e67baca651980.4372719025458551567@excalamus.com> (raw)
In-Reply-To: <87wmp17bbk.fsf@pelzflorian.de>
---- On Sat, 13 Apr 2024 13:26:39 +0200 pelzflorian (Florian Pelz) wrote ---
> @xref produces a capital See instead of see. This should be @pxref.
> See the Texinfo manual “info texinfo” or the Web manual Ludo points to.
>
> In info, this will use the word *note instead of *see, but it’s still
> right, if Matt you agree.
Yes, rereading the linked docs, it is as you say.
The problem is that the Emacs Info reader incorrectly renders cross-references by default. I was reading the Texinfo documentation in Emacs.
The default Emacs rendering of the Texinfo info file looks like:
#+begin_src info
‘@xref’
Used to start a sentence with an Info cross-reference saying ‘see
NAME.’ or with 'See ...' in other output formats.
‘@ref’
Used within or, more often, at the end of a sentence; produces an
Info cross-reference saying ‘see NAME.’, and just the
reference in other output formats, without the preceding 'See'.
#+end_src
Specifically, it misleadingly replaces info file instances of "*Note", which correspond to @xref, with (lowercase 's') "see ".
A workaround is use (setq Info-hide-note-references nil)
I was unable to fix the issue in Emacs and have filed a bug report.
> Additionally, the commit message’s first sentence should end with a
> period. The sentences in the commit message describing a section should
> start with a capital letter.
Thank you for the reminder. I have made a note to check this for my future submissions.
next prev parent reply other threads:[~2024-04-14 14:51 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
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 [this message]
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=18edd168cf4.10e67baca651980.4372719025458551567@excalamus.com \
--to=matt@excalamus.com \
--cc=dev@jpoiret.xyz \
--cc=guix-devel@gnu.org \
--cc=ludo@gnu.org \
--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).