rst header incorrectly transformed - issues with Windows line endings

[epogrebnyak]

Main
====

become

Main ====

after running style-doc and not longer recognised as header. I think this is not intended behaviour.

[PhilipMay]

Hey @epogrebnyak
many thanks for reporting this. I will investigate it.

[epogrebnyak]

Maybe not tested on Windows and \r\n not appreciated?

[PhilipMay]

I can confirm it. It is a windows \r\n newline issue.
I added a test for linux encoding:

style-doc/tests/test_style_doc.py

Lines 19 to 30 in 34744cd

	def test_linux_line_separators(tmpdir):
	tmp_file_name = os.path.join(tmpdir, "file.rst")
	with open(tmp_file_name, "w") as f:
	f.write("Main\n====\n")
	os.system(f"style-doc --max_len 99 {tmpdir}")
	with open(tmp_file_name, "r") as f:
	content = f.readlines()
	assert content[0] == "Main\n"
	assert content[1] == "=" * 99 + "\n"

If you see a way how to fix it - feel free for a PR.

[PhilipMay]

It should be possible to read the file and convert all newlines to \n while reading it:
https://docs.python.org/3/library/functions.html#open

[epogrebnyak]

Similarly to the test code, when new line is not specified, open() transforms any newlines to \n (universal newline), so for the PR I'll just try skipping the new line parameter in open().

[PhilipMay]

@epogrebnyak this is fixed - see fbf9974

[PhilipMay]

@epogrebnyak I made a new release on pypi. Can you please update the package and try it on your side?

[epogrebnyak]

Great, thanks, looks fixed. As a side comment the newlines after formatting the newlines are just \n, not \r\n\ but I think one can live with that.