bug#22874: 25.0.91; whitespace.el documentation looks incorrect

bug#22874: 25.0.91; whitespace.el documentation looks incorrect

[David Caldwell]

[-- Attachment #1.1: Type: text/plain, Size: 648 bytes --]

Hello,

M-x describe-variable RET whitespace-style RET

says:

[snip]

   indentation::tab     8 or more SPACEs at beginning of line are
                        visualized via faces.
                        It has effect only if ‘face’ (see above)
                        is present in ‘whitespace-style’.

   indentation::space   TABs at beginning of line are visualized via
                        faces.
                        It has effect only if ‘face’ (see above)
                        is present in ‘whitespace-style’.

[snip]

That looks backward to me. Attached is a patch that fixes it.

-David

[-- Attachment #1.2: whitespace.doc-fix.patch --]
[-- Type: text/plain, Size: 724 bytes --]

diff --git a/lisp/whitespace.el b/lisp/whitespace.el
index 53bf363..c4d74cb 100644
--- a/lisp/whitespace.el
+++ b/lisp/whitespace.el
@@ -440,12 +440,12 @@ whitespace-style
 			It has effect only if `face' (see above)
 			is present in `whitespace-style'.
 
-   indentation::tab	8 or more SPACEs at beginning of line are
+   indentation::space	8 or more SPACEs at beginning of line are
 			visualized via faces.
 			It has effect only if `face' (see above)
 			is present in `whitespace-style'.
 
-   indentation::space	TABs at beginning of line are visualized via
+   indentation::tab	TABs at beginning of line are visualized via
 			faces.
 			It has effect only if `face' (see above)
 			is present in `whitespace-style'.

[-- Attachment #2: S/MIME Cryptographic Signature --]
[-- Type: application/pkcs7-signature, Size: 3819 bytes --]

bug#22874: 25.0.91; whitespace.el documentation looks incorrect

[Lars Ingebrigtsen]

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

David Caldwell <david@porkrind.org> writes:

> Hello,
>
> M-x describe-variable RET whitespace-style RET
>
> says:
>
> [snip]
>
>    indentation::tab     8 or more SPACEs at beginning of line are
>                         visualized via faces.
>                         It has effect only if ‘face’ (see above)
>                         is present in ‘whitespace-style’.
>
>    indentation::space   TABs at beginning of line are visualized via
>                         faces.
>                         It has effect only if ‘face’ (see above)
>                         is present in ‘whitespace-style’.

I tried to reproduce this bug with the following file:


[-- Attachment #2: white.bin --]
[-- Type: application/octet-stream, Size: 54 bytes --]

        Foo Space
	Foo Tab
	Zot Tab
        Yes Space

[-- Attachment #3: Type: text/plain, Size: 379 bytes --]


But with either

(setq whitespace-style '(face indentation::tab))
(setq whitespace-style '(face indentation::space))

and then `M-x whitespace-mode'

just the lines with leading spaces were fontified.

So this either doesn't seem to work at all, or I'm just doing it wrong.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#22874: 25.0.91; whitespace.el documentation looks incorrect

[Stefan Kangas]

tags 22874 + moreinfo
thanks

Hi David,

Lars Ingebrigtsen <larsi@gnus.org> writes:

> David Caldwell <david@porkrind.org> writes:
>
>> Hello,
>>
>> M-x describe-variable RET whitespace-style RET
>>
>> says:
>>
>> [snip]
>>
>>    indentation::tab     8 or more SPACEs at beginning of line are
>>                         visualized via faces.
>>                         It has effect only if ‘face’ (see above)
>>                         is present in ‘whitespace-style’.
>>
>>    indentation::space   TABs at beginning of line are visualized via
>>                         faces.
>>                         It has effect only if ‘face’ (see above)
>>                         is present in ‘whitespace-style’.
>
> I tried to reproduce this bug with the following file:
>
>
>
> But with either
>
> (setq whitespace-style '(face indentation::tab))
> (setq whitespace-style '(face indentation::space))
>
> and then `M-x whitespace-mode'
>
> just the lines with leading spaces were fontified.
>
> So this either doesn't seem to work at all, or I'm just doing it wrong.

We seem to be needing more info to make any progress here.  Could you
take a look at the above and explain the issue you are seeing?

If I don't hear back from you within a couple of weeks, I'll just
close this bug as unreproducible.

Best regards,
Stefan Kangas

bug#22874: 25.0.91; whitespace.el documentation looks incorrect

[David Caldwell]

Hi,

On 8/14/20 9:32 PM, Stefan Kangas wrote:
> tags 22874 + moreinfo
> thanks
> 
> Hi David,
> 
> Lars Ingebrigtsen <larsi@gnus.org> writes:
> 
>> David Caldwell <david@porkrind.org> writes:
>>
>>> Hello,
>>>
>>> M-x describe-variable RET whitespace-style RET
>>>
>>> says:
>>>
>>> [snip]
>>>
>>>    indentation::tab     8 or more SPACEs at beginning of line are
>>>                         visualized via faces.
>>>                         It has effect only if ‘face’ (see above)
>>>                         is present in ‘whitespace-style’.
>>>
>>>    indentation::space   TABs at beginning of line are visualized via
>>>                         faces.
>>>                         It has effect only if ‘face’ (see above)
>>>                         is present in ‘whitespace-style’.
>>
>> I tried to reproduce this bug with the following file:
>>
>> But with either
>>
>> (setq whitespace-style '(face indentation::tab))
>> (setq whitespace-style '(face indentation::space))
>>
>> and then `M-x whitespace-mode'
>>
>> just the lines with leading spaces were fontified.
>>
>> So this either doesn't seem to work at all, or I'm just doing it wrong.
>
> We seem to be needing more info to make any progress here.  Could you
> take a look at the above and explain the issue you are seeing?

I just tested it in Emacs 27.1 and they both seem to work exactly as
documented.

I was initially confused because why would setting `indentation::tab`
show spaces at the beginning of a line and why would
`indentation::space` show tabs? I thought they just got switched around
in the docs, but I guess maybe it's supposed to act like an assertion?
`indentation::space` means "I expect my file to be indented with spaces
so please highlight any stray tab indents", and `indentation::tab` means
"I expect my file to be indented with tabs so highlight any `tab-width`
long runs of spaces".

Bottom line: I'm wrong, my patch is wrong, and the docs *are* correct.
Sorry to waste your time. :-)

-David

bug#22874: 25.0.91; whitespace.el documentation looks incorrect

[Bhavin Gandhi]

tags 22874 + notabug
close 22874
thanks

On Sun, 16 Aug 2020 at 00:11, David Caldwell <david@porkrind.org> wrote:
> >
> > We seem to be needing more info to make any progress here.  Could you
> > take a look at the above and explain the issue you are seeing?
>
> I just tested it in Emacs 27.1 and they both seem to work exactly as
> documented.

Thank you, closing this.