Removing the Misc/Vim/ files #54102

pitrou · 2010-09-18T16:34:45Z

BPO	9893
Nosy	@brettcannon, @orsenthil, @merwok
Files	README.vim: Sample README.vim file for issue 9893

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/brettcannon'
closed_at = <Date 2012-11-15.21:17:56.973>
created_at = <Date 2010-09-18.16:34:44.660>
labels = ['easy']
title = 'Removing the Misc/Vim/ files'
updated_at = <Date 2013-07-14.13:52:18.710>
user = 'https://github.com/pitrou'

bugs.python.org fields:

activity = <Date 2013-07-14.13:52:18.710>
actor = 'brett.cannon'
assignee = 'brett.cannon'
closed = True
closed_date = <Date 2012-11-15.21:17:56.973>
closer = 'brett.cannon'
components = ['None']
creation = <Date 2010-09-18.16:34:44.660>
creator = 'pitrou'
dependencies = []
files = ['22981']
hgrepos = []
issue_num = 9893
keywords = ['easy']
message_count = 19.0
messages = ['116812', '116825', '116990', '123852', '124591', '124653', '124726', '124907', '124924', '142252', '142655', '142771', '175643', '175648', '175663', '175782', '193020', '193050', '193051']
nosy_count = 6.0
nosy_names = ['brett.cannon', 'orsenthil', 'eric.araujo', 'python-dev', 'gjcross', 'iwontbecreative']
pr_nums = []
priority = 'low'
resolution = 'fixed'
stage = 'resolved'
status = 'closed'
superseder = None
type = None
url = 'https://bugs.python.org/issue9893'
versions = ['Python 3.3']

pitrou · 2010-09-18T16:34:44Z

While trying out vim, I noticed that the files in Misc/Vim are very poor compared to what is otherwise provided by the vim community:

highlighting including 3.x syntax: http://www.vim.org/scripts/script.php?script_id=974
PEP-8 indentation: http://www.vim.org/scripts/script.php?script_id=974

Also, the vimrc uses "au BufRead,BufNewFile *.py" style selection, while the recommended modern style seems to use a ".vim/ftplugin" filetype-specific file instead.

Does it still make sense to maintain these files separately?

brettcannon · 2010-09-18T19:16:16Z

So the irony of saying that the files are poor is that I took that code from the highlight file from Vim itself and simply automated the creation of the files.

As for the more proper way of selecting when to apply the highlights, I would not be surprised that I am wrong.

The entire point of the Misc/Vim directory was so that we had files which were as up-to-date as svn is. I personally got tired of not having new keywords be recognized. I'm no Vim expert -- just a happy user -- so I'm sure there could be better out there. If we drop the files we will just have to go back to manually editing files to support new syntax until the community picks it up. But maybe devolving responsibility like that is not a bad thing.

And your link for the Python 3 syntax is incorrect; it's the same as the PEP-8 indentation file.

merwok · 2010-09-20T22:19:34Z

Those files are useful for me, even if I had to tweak them slightly.

brettcannon · 2010-12-12T21:52:25Z

So I just looked at the syntax file linked by Antoine and that is definitely *not* what he meant to link to; probably meant http://www.vim.org/scripts/script.php?script_id=790 . As for the indentation file, it's out-of-date and so doesn't support 'with' statements (looks like people have already started to fork it: http://www.vim.org/scripts/script.php?script_id=3003).

At this point I'm willing to either hand maintenance of the files over to someone else or to delete the files and shift what we point people at.

orsenthil · 2010-12-24T04:26:19Z

On Sun, Dec 12, 2010 at 09:52:27PM +0000, Brett Cannon wrote:

At this point I'm willing to either hand maintenance of the files
over to someone else or to delete the files and shift what we point
people at.

I think, just pointing to the script at vim.org location is a good
idea. It is maintained and updated by vimmers and we dont have to
bother about it. But a README would be helpful as what scripts we
"recommend", so that it sufficient to meet the style guidelines of
PEP-8 and PEP-7.

merwok · 2010-12-25T23:09:38Z

“It is maintained and updated by vimmers and we dont have to bother about it” is trumped by “I personally got tired of not having new keywords be recognized”.

brettcannon · 2010-12-27T19:59:44Z

But if you have a local copy of the Vim files from the community what is preventing you from editing them for new keywords and sending a patch to the maintainer so that the rest of the community is brought up to speed that much faster?

I suspect that not many people beyond core devs use the Misc/Vim file while more people in the community use the vim.org files.

orsenthil · 2010-12-30T06:46:32Z

On Mon, Dec 27, 2010 at 07:59:46PM +0000, Brett Cannon wrote:

But if you have a local copy of the Vim files from the community
what is preventing you from editing them for new keywords and
sending a patch to the maintainer so that the rest of the community
is brought up to speed that much faster?

You mean the Python Core Dev maintaining a set of Vim files as a fork
from the vim.org maintained files and adding new features when they
come up and be submitted the vim.org.

If that is the idea, it is indeed a good one.

But often it has happened that someone at the vim.org has noticed the
changes in Python and updated the files and the scripts at vim.org
remain updated.

I suspect that not many people beyond core devs use the Misc/Vim
file while more people in the community use the vim.org files.

Possibly and perhaps that is reason to discard our Misc/Vim in favor
of vim.org files.

But if you think there *should* be an official recommendation, some
pointers would definitely serve.

merwok · 2010-12-30T18:10:24Z

Alright, let me change my opinion: Let’s replace the Vim files by a README.vim file explaining where to get good helper files (like Misc/README.emacs added in r85927). Then I will learn how to manage my Vim configuration to keep it updated (and adequate for each Python version), and when needed contact the Vim community to request updates.

brettcannon · 2011-08-17T04:01:49Z

OK, I like Eric's idea of the README.vim file explaining where to grab the community-maintained files and how to get set up. Anyone care to take a stab at writing the file?

gjcross · 2011-08-22T01:53:11Z

Here is a first pass at the README.vim file. Suggestions welcome from VIM power-users!

merwok · 2011-08-22T23:15:33Z

To download the current release of python.vim, which is an enhanced
version of the python syntax highlighting script that conforms with
PEP-8, and is actively maintained by the Vim community.
s/python/Python/

I think the bit about “enhanced version” could be puzzling. Either say “an enhanced version of the python.vim file that used to be included in the Python repository”, or just delete that part (my preference).

To update your .vimrc configuration file with Python-appropriate
settings, use the sample file from Misc/Vim/vimrc.
The idea is to delete all of Misc/Vim.

More comprehensive integration of Vim with Python tools and
frameworks can be found at:

http://sontek.net/turning-vim-into-a-modern-python-ide
I’m not sure we want to add links to specific articles; for example, I had to combine tips from many websites/blogs to have an efficient setup. I suggest our README.vim only points to wim.org pages, and other links can be added to the Vim wikis.

brettcannon · 2012-11-15T21:17:57Z

Files removed in 7e37a6c76e36.

merwok · 2012-11-15T21:46:55Z

Did you decide against including README.vim after all or just forgot that part?

brettcannon · 2012-11-16T02:27:11Z

I decided against it. If Emacs doesn't already have one I figured Vim shouldn't either.

merwok · 2012-11-17T17:21:28Z

I had forgotten that README.Emacs was moved to the devguide. Adding doc about Vim support can be another bug report. Thanks.

iwontbecreative · 2013-07-14T02:28:10Z

The files weres indeed removed but Misc/Readme was not updated accordingly. The last line needs to be removed.

python-dev · 2013-07-14T13:50:59Z

New changeset afd17a514117 by Brett Cannon in branch 'default':
Issue bpo-9893: remove an outdated mention of the Vim-related files.
http://hg.python.org/cpython/rev/afd17a514117

brettcannon · 2013-07-14T13:52:19Z

Thanks for the info, Févry.

pitrou added the performance Performance or resource usage label Sep 18, 2010

merwok removed the performance Performance or resource usage label Dec 30, 2010

brettcannon self-assigned this Jan 24, 2011

brettcannon added the easy label Aug 17, 2011

merwok changed the title ~~Usefulness of the Misc/Vim/ files?~~ Removing the Misc/Vim/ files Aug 22, 2011

brettcannon closed this as completed Nov 15, 2012

ezio-melotti transferred this issue from another repository Apr 10, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Removing the Misc/Vim/ files #54102

Removing the Misc/Vim/ files #54102

pitrou commented Sep 18, 2010

pitrou commented Sep 18, 2010

brettcannon commented Sep 18, 2010

merwok commented Sep 20, 2010

brettcannon commented Dec 12, 2010

orsenthil commented Dec 24, 2010

merwok commented Dec 25, 2010

brettcannon commented Dec 27, 2010

orsenthil commented Dec 30, 2010

merwok commented Dec 30, 2010

brettcannon commented Aug 17, 2011

gjcross mannequin commented Aug 22, 2011

merwok commented Aug 22, 2011

brettcannon commented Nov 15, 2012

merwok commented Nov 15, 2012

brettcannon commented Nov 16, 2012

merwok commented Nov 17, 2012

iwontbecreative mannequin commented Jul 14, 2013

python-dev mannequin commented Jul 14, 2013

brettcannon commented Jul 14, 2013

Removing the Misc/Vim/ files #54102

Removing the Misc/Vim/ files #54102

Comments

pitrou commented Sep 18, 2010

pitrou commented Sep 18, 2010

brettcannon commented Sep 18, 2010

merwok commented Sep 20, 2010

brettcannon commented Dec 12, 2010

orsenthil commented Dec 24, 2010

merwok commented Dec 25, 2010

brettcannon commented Dec 27, 2010

orsenthil commented Dec 30, 2010

merwok commented Dec 30, 2010

brettcannon commented Aug 17, 2011

gjcross mannequin commented Aug 22, 2011

merwok commented Aug 22, 2011

brettcannon commented Nov 15, 2012

merwok commented Nov 15, 2012

brettcannon commented Nov 16, 2012

merwok commented Nov 17, 2012

iwontbecreative mannequin commented Jul 14, 2013

python-dev mannequin commented Jul 14, 2013

brettcannon commented Jul 14, 2013