Gnus development mailing list
 help / color / mirror / Atom feed
From: "Garreau\, Alexandre" <galex-713@galex-713.eu>
To: Eric Abrahamsen <eric@ericabrahamsen.net>
Cc: ding@gnus.org
Subject: Re: `gnus-build-sparse-threads' docstring
Date: Thu, 18 Oct 2018 18:35:53 +0200	[thread overview]
Message-ID: <87bm7rtdp2.fsf@portable.galex-713.eu> (raw)
In-Reply-To: <87ftx3443a.fsf@ericabrahamsen.net> (Eric Abrahamsen's message of "Thu, 18 Oct 2018 09:22:33 -0700")

Le 18/10/2018 à 09h22, Eric Abrahamsen a écrit :
> "Garreau, Alexandre" <galex-713@galex-713.eu> writes:
>> When putting a raw symbol, not to be evaluated, in docstring,
>> `describe-variable' highlights these as links to same-name symbol
>> description (`describe-symbol').  Yet in `gnus-build-sparse-threads',
>> “'some” doesn’t refer to `some' (the cl function, alias for `cl-some'),
>> so I guess it would be more correctly written as “'some” or 'some
>> directly, instead of `some'.
>
> The automatic hyperlinking can be disabled when inappropriate by having
> the word "symbol" in front of the actual symbol. Here's a version that
> creates no hyperlinks, though it's a tiny bit strained:
>
> "If non-nil, fill in the gaps in threads.
> If set to the symbol `some', only fill in the gaps that are
> needed to tie loose threads together.  If the symbol `more', fill
> in all leaf nodes that Gnus can find.  If neither nil nor the
> symbol `some', fill in all gaps that Gnus manages to guess."

While discussing it on the emacs-devel mailing-list, I found it out
myself in the elisp manual ^^ I was going to write it out here before
reading your message x)

Shouldn’t it be changed in Gnus so the docstring displays correctly?



  reply	other threads:[~2018-10-18 16:35 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-10-18 13:57 Garreau, Alexandre
2018-10-18 14:14 ` Garreau, Alexandre
2018-10-18 16:41   ` Eric Abrahamsen
2018-10-18 16:22 ` Eric Abrahamsen
2018-10-18 16:35   ` Garreau, Alexandre [this message]
2018-10-18 18:46     ` Eric Abrahamsen

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=87bm7rtdp2.fsf@portable.galex-713.eu \
    --to=galex-713@galex-713.eu \
    --cc=ding@gnus.org \
    --cc=eric@ericabrahamsen.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.
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 NNTP newsgroup(s).