bug#33090: 27.0.50; Deactivate incorrect hyperlinking in the docstring of gnus-build-sparse-threads

bug#33090: 27.0.50; Deactivate incorrect hyperlinking in the docstring of gnus-build-sparse-threads

[Eric Abrahamsen]

[-- Attachment #1: Type: text/plain, Size: 164 bytes --]


The symbol `some' is incorrectly treated as a hyperlink to the function
`some' in this docstring. This patch wiggles the word "symbol" in there
to deactivate it.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: 0001-Deactivate-incorrect-hyperlinking-in-gnus-build-spar.patch --]
[-- Type: text/x-patch, Size: 1291 bytes --]

From 4b9d708e05790a555b073ea73c96018a65a53145 Mon Sep 17 00:00:00 2001
From: Eric Abrahamsen <eric@ericabrahamsen.net>
Date: Thu, 18 Oct 2018 11:32:47 -0700
Subject: [PATCH] Deactivate incorrect hyperlinking in
 gnus-build-sparse-threads doc

* lisp/gnus/gnus-sum.el (gnus-build-sparse-threads): Add the word
  "symbol" so it doesn't link to the `some' function.
---
 lisp/gnus/gnus-sum.el | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/lisp/gnus/gnus-sum.el b/lisp/gnus/gnus-sum.el
index f56b822ac5..a1ee2aaf3a 100644
--- a/lisp/gnus/gnus-sum.el
+++ b/lisp/gnus/gnus-sum.el
@@ -203,9 +203,10 @@ gnus-simplify-ignored-prefixes
 
 (defcustom gnus-build-sparse-threads nil
   "If non-nil, fill in the gaps in threads.
-If `some', only fill in the gaps that are needed to tie loose threads
-together.  If `more', fill in all leaf nodes that Gnus can find.  If
-non-nil and non-`some', fill in all gaps that Gnus manages to guess."
+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 t (or any other value),
+fill in all gaps that Gnus manages to guess."
   :group 'gnus-thread
   :type '(choice (const :tag "off" nil)
 		 (const some)
-- 
2.19.1

bug#33090: 27.0.50; Deactivate incorrect hyperlinking in the docstring of gnus-build-sparse-threads

[Robert Pluim]

Eric Abrahamsen <eric@ericabrahamsen.net> writes:

> The symbol `some' is incorrectly treated as a hyperlink to the function
> `some' in this docstring. This patch wiggles the word "symbol" in there
> to deactivate it.
>

Since youʼre there anyway: thereʼs one in `gnus-fetch-old-headers' as
well.

Robert

bug#33090: 27.0.50; Deactivate incorrect hyperlinking in the docstring of gnus-build-sparse-threads

[Eric Abrahamsen]

On 10/19/18 09:45 AM, Robert Pluim wrote:
> Eric Abrahamsen <eric@ericabrahamsen.net> writes:
>
>> The symbol `some' is incorrectly treated as a hyperlink to the function
>> `some' in this docstring. This patch wiggles the word "symbol" in there
>> to deactivate it.
>>
>
> Since youʼre there anyway: thereʼs one in `gnus-fetch-old-headers' as
> well.

Thanks for the tip. I started finding more similar problems, then
hauled out checkdoc and started using that, and fell down a rabbit hole.
I have a long flight on Sunday, I might try to do a full documentation
sweep then. What Gnus really needs is docstrings where it currently
doesn't have them, but this would be an okay start.

bug#33090: 27.0.50; Deactivate incorrect hyperlinking in the docstring of gnus-build-sparse-threads

[Eli Zaretskii]

> X-Spam-Status: No, score=-2.9 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI
> 	autolearn=disabled version=3.3.2
> Resent-From: Eric Abrahamsen <eric@ericabrahamsen.net>
> Original-Sender: "Debbugs-submit" <debbugs-submit-bounces@debbugs.gnu.org>
> Resent-CC: bug-gnu-emacs@gnu.org
> Resent-Sender: help-debbugs@gnu.org
> From: Eric Abrahamsen <eric@ericabrahamsen.net>
> Date: Thu, 18 Oct 2018 11:37:48 -0700
> 
> The symbol `some' is incorrectly treated as a hyperlink to the function
> `some' in this docstring. This patch wiggles the word "symbol" in there
> to deactivate it.

Thanks, pushed to the release branch.

bug#33090: 27.0.50; Deactivate incorrect hyperlinking in the docstring of gnus-build-sparse-threads

[Eli Zaretskii]

> From: Robert Pluim <rpluim@gmail.com>
> Date: Fri, 19 Oct 2018 09:45:38 +0200
> Cc: 33090@debbugs.gnu.org
> 
> Eric Abrahamsen <eric@ericabrahamsen.net> writes:
> 
> > The symbol `some' is incorrectly treated as a hyperlink to the function
> > `some' in this docstring. This patch wiggles the word "symbol" in there
> > to deactivate it.
> >
> 
> Since youʼre there anyway: thereʼs one in `gnus-fetch-old-headers' as
> well.

Done, thanks.