DOC: Specify encoding of rst file, remove an ambiguity in an SVD example #8706
Conversation
pvanmulbregt
added
the
Documentation
tools/refguide_check.py
Outdated
| if sys.version_info.major <= 2: | ||
| text = open(fname).read() | ||
| else: | ||
| text = open(fname, encoding='utf-8').read() |
There was a problem hiding this comment.
This could probably be:
with codecs.open(fname, encoding='utf-8') as fid:
text = fid.read()
That should work on 2 and 3, and properly close the file.
There was a problem hiding this comment.
Would that not change the semantics slightly? I believe that codecs.open() opens in binary mode and doesn't do '\n' conversion, and in Py2 it would always return Unicode. I did think about using io.open(fname, encoding='utf-8') but didn't because text would now be a Unicode object in Py2 and downstream code may not be expecting Unicode.
There was a problem hiding this comment.
Well if it broke things we should probably fix those downstream things to handle unicode. But for now (esp. since Py2 support will be dropped within a year) we can go with your solution, but please change it to use the context manager to properly close the file.
|
Looks good. Thanks @pvanmulbregt |
During execution of
python runtests.py -g --regime-checkopen a text file using encoding utf-8 under Python 3, leave as is for Py2.Multiply a 2x1 matrix by the sign of the first element to remove some ambiguity in a linalg.svd null_space example.
Closes gh-8703.