Re: Keep/drop emacs variables in documentation sources?
Guenter Milde via Docutils-develop <[email protected]>
| Newsgroups | gmane.text.docutils.devel |
|---|---|
| Message-ID | <[email protected]> |
On 2024-04-26, Karl O. Pinc wrote on Fri, 26 Apr 2024 > Guenter Milde via <[email protected]> wrote: >> On 2024-04-24, G. Branden Robinson wrote: >> > At 2024-04-24T19:06:23-0000, Guenter Milde wrote: >> >> So my question is: >> >> * Do we want to keep the emacs variables block? ... >> If there are no objections, I would sacrifice the FORM FEED >> in favour of a simple commit test for trailing whitespace. > I am no expert; note the emacs docs say: ... ><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. Sounds reasonable. 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 Regards, Günter _______________________________________________ Docutils-develop mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/docutils-develop Please use "Reply All" to reply to the list.