IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Remove unnecessary encoding cookie from Python source files

Browse Source 
In Python 3, the default encoding of source files is utf-8. The encoding
cookie is now unnecessary and redundant so remove it. For more details,
see the docs:

https://docs.python.org/3/howto/unicode.html#the-string-type

> The default encoding for Python source code is UTF-8, so you can
> simply include a Unicode character in a string literal ...

Includes a fix for the flake8 header checks to stop expecting an
encoding cookie.
This commit is contained in:
Jon Dufresne
2018-12-16 12:01:04 -08:00
parent 30ec4b6bba
commit bade33c7e4
270 changed files with 7 additions and 284 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
utils/checks.py
View File

@@ -1,4 +1,3 @@
# -*- coding: utf-8 -*-
"""
utils.checks
~~~~~~~~~~~~
@@ -70,9 +69,6 @@ def sphinx_has_header(physical_line, filename, lines, line_number):
for lno, line in enumerate(lines):
llist.append(line)
if lno == 0:
if line != '# -*- coding: utf-8 -*-\n':
return 0, 'X101 missing coding declaration'
elif lno == 1:
if line != '"""\n' and line != 'r"""\n':
return 0, 'X101 missing docstring begin (""")'
else:
@@ -80,20 +76,20 @@ def sphinx_has_header(physical_line, filename, lines, line_number):
elif doc_open:
if line == '"""\n':
# end of docstring
if lno <= 4:
if lno <= 3:
return 0, 'X101 missing module name in docstring'
break
if line != '\n' and line[:4] != ' ' and doc_open:
return 0, 'X101 missing correct docstring indentation'
if lno == 2:
if lno == 1:
mod_name_len = len(line.strip())
if line.strip() != mod_name:
return 4, 'X101 wrong module name in docstring heading'
elif lno == 3:
return 2, 'X101 wrong module name in docstring heading'
elif lno == 2:
if line.strip() != mod_name_len * '~':
return (4, 'X101 wrong module name underline, should be '
return (3, 'X101 wrong module name underline, should be '
'~~~...~')
else:
return 0, 'X101 missing end and/or start of docstring...'