[docutils:patches] #187 Rename .txt files to .rst

Günter Milde via Docutils-develop <[email protected]> Thu, 08 Aug 2024 19:36:14 -0000
Newsgroups gmane.text.docutils.devel
Message-ID </p/docutils/patches/187/51c9344c71d2eeb1d1b41a84e566032bda7a13dc.patches@docutils.p.sourceforge.net>
Thinking about this, I now favour changing the extension of rST source files to `.rst`. The PEP sources at peps.python.org are an "official precedence case".

Writer template files  are *not* rST sources and should keep their extension.

Standard include files shoud change after an advance warning and transition period.
(We can implement a fallback with warning in the "include" directive implementation.)


---

**[patches:#187] Rename .txt files to .rst**

**Status:** pending-remind
**Group:** None
**Created:** Wed Jan 05, 2022 05:51 PM UTC by Adam  Turner
**Last Updated:** Thu Feb 17, 2022 02:07 PM UTC
**Owner:** David Goodger


This change is in two parts -- the first commit does the rename and the second goes through and updates references to .txt files. All tests pass.

The benefit of this change is primarily for people -- on user interfaces with syntax highlighting (e.g. IntelliJ / VSCode / Notepad++ editors, code mirrors, etc), the text is presented natively as reStructuredText, and editor features can assist with e.g. autocompletion.

Docutils itself of course does not care which file extension is used. 

I have not renamed any of the include files or template files in `docutils.parsers` or `docutils.writers`, as they form part of the public API and would need a deprecation cycle (or aliasing in the parsing code)

A

Please see https://github.com/AA-Turner/docutils/pull/3 and https://github.com/AA-Turner/docutils/pull/3.patch for the commits and patch.


---

Sent from sourceforge.net because [email protected] is subscribed to https://sourceforge.net/p/docutils/patches/

To unsubscribe from further messages, a project admin can change settings at https://sourceforge.net/p/docutils/admin/patches/options.  Or, if this is a mailing list, you can unsubscribe from the mailing list.