Re: `gnus-build-sparse-threads' docstring

[Eric Abrahamsen <eric@ericabrahamsen.net>]

"Garreau, Alexandre" <galex-713@galex-713.eu> writes:

> 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?

Probably, yes. I've opened bug bug#33090 with a patch for this.

Thanks,
Eric