Re: [Docutils-develop] Keep/drop emacs variables in documentation sources?

[Karl O. P. <ko...@ka...>]

On Sat, 27 Apr 2024 11:04:09 -0000 (UTC)
Guenter Milde via Docutils-develop
<doc...@li...> wrote:

> On 2024-04-26, Karl O. Pinc wrote on Fri, 26 Apr 2024
> > Guenter Milde via <doc...@li...> wrote:  
> >> On 2024-04-24, G. Branden Robinson wrote:  
> >> > At 2024-04-24T19:06:23-0000, Guenter Milde wrote:  

> >> If there are no objections, I would sacrifice the FORM FEED
> >> in favour of a simple commit test for trailing whitespace.

> ><snip>
> >    If some unrelated text might look to Emacs as a local variables
> > list, you can countermand that by inserting a form-feed character
> > (a page delimiter, see Pages) after that text.  Emacs only looks for
> > file-local variables in the last page of a file, after the last page
> > delimiter.  
> 
> > So my guess is that the line feed is a "guard" that allows RST
> > files to end in something that looks to emacs like a local variable
> > list, but is intended to be document text.  This does sound like
> > it could be useful in special edge cases.  

> How about this change then:
> 
> diff --git a/docutils/docs/ref/doctree.txt
> b/docutils/docs/ref/doctree.txt index 6798300a3..ca66796b4 100644
> --- a/docutils/docs/ref/doctree.txt
> +++ b/docutils/docs/ref/doctree.txt
> @@ -5147,8 +5147,8 @@ models of the following elements:
> `\<abbreviation>`_, .. _table of compatible image formats:
> rst/directives.html#image-formats 
>  
> -
> -..
> +.. Emacs settings
> +
>     Local Variables:
>     mode: indented-text
>     indent-tabs-mode: nil

Makes sense to me.

Regards,

Karl <ko...@ka...>
Free Software:  "You don't pay back, you pay forward."
                 -- Robert A. Heinlein