#18448: Rename all documentation files to have .rst extension
-------------------------------------+-------------------------------------
Reporter: Marc Tamlyn | Owner: nobody
Type: | Status: closed
Cleanup/optimization |
Component: Documentation | Version: 1.4
Severity: Normal | Resolution: wontfix
Keywords: | Triage Stage:
| Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 0 | UI/UX: 0
-------------------------------------+-------------------------------------
Comment (by Mike Lissner):
I just did some work on documentation today and I found the use if txt
extensions instead of rst extension to be a bit frustrating. For example,
my editor couldn't treat these as ReStructured Text, and then when I was
writing my pull request, I couldn't review my work in Github either.
Similarly, for whomever reviews my PR, they won't be able to review it on
Github either, and will have to do so on their laptop, which is an extra
step for them.
I guess I understand the explanation from nine years ago that some people
won't be able to open rst files in their editor, but I think if Github
supports these natively, we can assume that just about everybody
contributing documentation would support them natively too.
Should we reconsider this one? I'd happily make a little PR to rename
files if so.
--
Ticket URL: <https://code.djangoproject.com/ticket/18448#comment:2>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.
--
You received this message because you are subscribed to the Google Groups
"Django updates" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/django-updates/066.1393e7c5b42d87e68c5e74e82d903164%40djangoproject.com.
