Remove the spell env - Githubissues

ionelmc / cookiecutter-pylibrary

Enhanced cookiecutter template for Python libraries.

BSD 2-Clause "Simplified" License

1.25k stars 207 forks source link

Remove the spell env #164

Closed ionelmc closed 5 years ago

ionelmc commented 5 years ago

it's cumbersome as you have to whitelist almost all programming jargon and names
it's mostly and useless appendix - doesn't run in CI
it relies on the unmaintained pyenchant lib

@dHannasch @joaomcteixeira now only thing left is to recommend some alternatives to checking spelling besides pycharm/other-big-IDE.

Closes #163. Closes #160. Closes #159. Closes #12.

ionelmc commented 5 years ago

So bottom line: do you think it's still worth having the sphinx spellchecker?

dHannasch commented 5 years ago

I don't really care about testenv:spell one way or the other, but I feel the need to point out that it turns out suppressing the warning isn't nearly as cumbersome as that source-editing thing you saw that I first pushed. It's literally one line (except for the comments). https://github.com/ionelmc/cookiecutter-pylibrary/pull/163/files

ionelmc commented 5 years ago

@joaomcteixeira please tell me you don't really need the spell env :)

joaomcteixeira commented 5 years ago

Hehehe, I don't really need it, Vim has very nice spellcheck :P. And as said in the other PR discussion, I can add it manually if I want. I raised this discussion because I couldn't understand why spellcheck was not more integrated in the CI and tox loop; but now with all the discussions you provided I understand your decisions and the strategy for the project.

now only thing left is to recommend some alternatives to checking spelling besides pycharm/other-big-IDE

I will keep an eye on this and let you know if I find something.

Hmm, pure technical question from complete ignorance of mine, why you dropped 3.4?

ionelmc commented 5 years ago

@joaomcteixeira 3.4 is dead: https://www.python.org/downloads/release/python-3410/