Ex-Mente / auxi.0

GNU Lesser General Public License v3.0
8 stars 8 forks source link

Consistency of encoding declaration #208

Open alchemyst opened 7 years ago

alchemyst commented 7 years ago

The advice in __init__.py includes the line

#TODO: Remove '# -*- coding: utf-8 -*-' from top of code files.

However, such encoding advice is considered best practice and is recommended in the Stack Overflow post linked to just above it. There are also still such lines in auxi/tools/chemistry/thermochemistry_test.py and doc/user/source/conf.py.

I think we should declare the encoding, remove this advice and replace it with advice about what encoding to use (I recommend utf-8).

christoffkok commented 7 years ago

I agree with this.

We should change this advice to keep / add '# -- coding: utf-8 --' to our code files.