This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Remove emacs page from devguide
Type: behavior Stage: resolved
Components: Devguide Versions:
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: ezio.melotti Nosy List: alooney, eric.araujo, ezio.melotti, pitrou, python-dev, r.david.murray, rhettinger, tshepang
Priority: normal Keywords: easy, patch

Created on 2013-12-24 15:23 by r.david.murray, last changed 2022-04-11 14:57 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
devguide.patch alooney, 2014-03-21 04:21
Messages (15)
msg206897 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2013-12-24 15:23
This is a followup to issue 9893.  There should be a section on vim in the devguide just like there is currently a section on emacs.
msg206898 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2013-12-24 15:26
The Misc/TextMate directory was also removed.  I wonder if what we really want is an 'editor support' chapter that lists best practice for any editor any committers use (and are willing to write the section for).
msg207009 - (view) Author: Tshepang Lekhonkhobe (tshepang) * Date: 2013-12-27 20:29
I think there should not be any section about any editor in the devguide. It's beyond scope, and it risks going stale.
msg207011 - (view) Author: R. David Murray (r.david.murray) * (Python committer) Date: 2013-12-27 21:30
We have pointers to external resources all over the docs.  Yes, they go stale sometimes, and when somebody notices, we update them.  "What do you use for development" is a common topic of discussion, so I don't see any reason not to include some pointers in the devguide.  (Not tutorials, just pointers to resources.)
msg207016 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2013-12-28 01:38
I don't think the devguide is a good place for this unless some editors support features that are particularly interesting for CPython development (e.g. something to check refleaks).
If the features are generic enough that any Python programmer would find them interesting, something could be said in the Python FAQs [0] or the wiki [1].  The FAQs already mention this briefly and have a link to the wiki.

[0]: http://docs.python.org/3/faq/general.html
[1]: https://wiki.python.org/moin/PythonEditors
msg211280 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2014-02-15 15:15
The emacs page (http://docs.python.org/devguide/emacs.html) could also be moved outside the devguide.
msg213940 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2014-03-18 03:49
I’m not opposed to the short page about Emacs currently in the devguide, and a similar page about vim could be useful (the default settings for indentation are bad), but I’m also not opposed with merging the contents into the wiki page about editors and just including a link to that from devguide and/or Python docs.

Antoine: you’re one of the people thinking the devguide is already too big; what’s your opinion on this?
msg214020 - (view) Author: Antoine Pitrou (pitrou) * (Python committer) Date: 2014-03-18 21:25
I agree with Ezio. Also, editor support is a moving target, and our guidelines may actually become obsolete.
msg214026 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2014-03-18 21:39
Alright.
msg214039 - (view) Author: Albert Looney (alooney) * Date: 2014-03-19 00:29
removing emacs from the devguide

Im am certainly new at this, so if this is incorrect please provide feedback.
msg214050 - (view) Author: Éric Araujo (eric.araujo) * (Python committer) Date: 2014-03-19 04:30
Thanks!  To complete the patch, you should also delete the emacs.rst file (patches created by Mercurial can represent file creation and deletion, not only changes).  The deleted content need to be added to the Python wiki (see link to the PythonEditors page in a previous message).
msg214325 - (view) Author: Albert Looney (alooney) * Date: 2014-03-21 04:21
Patch should be fixed now and remove emacs.rst file.

It seems to me that the Emacs information that is being deleted is already in the wiki.

https://wiki.python.org/moin/EmacsEditor
msg214326 - (view) Author: Raymond Hettinger (rhettinger) * (Python committer) Date: 2014-03-21 04:52
Ideally, the information should exist on the wiki (so it can easily be kept up-to-date) and the devguide should link to it (so new devs can find the resource).
msg221050 - (view) Author: Roundup Robot (python-dev) (Python triager) Date: 2014-06-19 23:18
New changeset a79c7088ed10 by Ezio Melotti in branch 'default':
#20062: replace emacs page of the devguide with a link to the PythonEditors wiki page.  Initial patch by Albert Looney.
http://hg.python.org/devguide/rev/a79c7088ed10
msg221051 - (view) Author: Ezio Melotti (ezio.melotti) * (Python committer) Date: 2014-06-19 23:19
Fixed, thanks for the patch!
History
Date User Action Args
2022-04-11 14:57:55adminsetgithub: 64261
2014-06-19 23:19:00ezio.melottisetstatus: open -> closed
messages: + msg221051

assignee: ezio.melotti
resolution: fixed
stage: needs patch -> resolved
2014-06-19 23:18:28python-devsetnosy: + python-dev
messages: + msg221050
2014-03-26 15:31:04alooneysetfiles: - index.patch
2014-03-21 04:52:54rhettingersetnosy: + rhettinger
messages: + msg214326
2014-03-21 04:21:36alooneysetfiles: + devguide.patch

messages: + msg214325
2014-03-19 04:30:52eric.araujosetmessages: + msg214050
2014-03-19 00:29:03alooneysetfiles: + index.patch

nosy: + alooney
messages: + msg214039

keywords: + patch
2014-03-18 21:39:59eric.araujosetkeywords: + easy

messages: + msg214026
title: Should the devguide document emacs/vim support? -> Remove emacs page from devguide
2014-03-18 21:25:47pitrousetmessages: + msg214020
2014-03-18 03:49:02eric.araujosetnosy: + eric.araujo

messages: + msg213940
title: Add section on vim to devguide -> Should the devguide document emacs/vim support?
2014-02-15 15:15:51ezio.melottisetmessages: + msg211280
2013-12-28 01:38:25ezio.melottisetnosy: + pitrou
messages: + msg207016
2013-12-27 21:30:27r.david.murraysetmessages: + msg207011
2013-12-27 20:29:54tshepangsetnosy: + tshepang
messages: + msg207009
2013-12-24 15:26:06r.david.murraysetmessages: + msg206898
2013-12-24 15:23:36r.david.murraycreate