search

jaseg / python-mpv

Python interface to the awesome mpv media player
https://git.jaseg.de/python-mpv.git
Other
554 stars 69 forks source link

Improve README.md syntax #25

Closed McSinyx closed 7 years ago

McSinyx commented 7 years ago

Fix spaces/tabs inconsistency, change sections to header 2 and rewrap paragraphs and comments (I know you're against this kind of commit, but those were wrapped at column 120, which is not, IMHO, a nice convention).

jaseg commented 7 years ago

Thank you for your effort. I have pushed a fix to master that should address most of these points. For some reason I managed to mix restructuredtext and markdown in the readme. I have now just made it all-rst and fixed the headline levels.

jaseg commented 7 years ago

I just noticed that you included a fix for the property observer example in the readme in your commit. I pushed that to master. Please try to separate that kind of thing from syntax changes and give it its own commit with a proper message^^

McSinyx commented 7 years ago

About the text width, I know it's for backward compatibility but it's really ugly on small terminal especially for text paragraphs (documentation, comments, doctrings, etc.) which get hanging-wrapped (sorry for my English, see the picture please):

less README.rst

I'd suggest 80 or no hard wrapping at all for those stuffs.

Also, how is the PyPI repo? I'd love to be able to install this by pip and use sth like install_requires=['python-mpv'] in my project setup.py.