]> gitweb @ CieloNegro.org - youtube-dl.git/commitdiff
[README.md] Add long lines policy to coding conventions
authorSergey M <dstftw@gmail.com>
Tue, 1 Jan 2019 16:50:02 +0000 (23:50 +0700)
committerGitHub <noreply@github.com>
Tue, 1 Jan 2019 16:50:02 +0000 (23:50 +0700)
README.md

index bdc5faeec7bc68e91f7caf45527f6e82226ea89c..901595444a291e81ad2b6bd37f5c1a0a384a524f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1192,6 +1192,25 @@ title = self._search_regex(
     webpage, 'title', group='title')
 ```
 
+### Long lines policy
+
+There is a soft limit to keep lines of code under 80 characters long. This means it should be respected if possible and if it does not make readability and code maintenance worse.
+
+For example, you should **never** split long string literals like URLs or some other often copied entities over multiple lines to fit this limit:
+
+Correct:
+
+```python
+'https://www.youtube.com/watch?v=FqZTN594JQw&list=PLMYEtVRpaqY00V9W81Cwmzp6N6vZqfUKD4'
+```
+
+Incorrect:
+
+```python
+'https://www.youtube.com/watch?v=FqZTN594JQw&list='
+'PLMYEtVRpaqY00V9W81Cwmzp6N6vZqfUKD4'
+```
+
 ### Use safe conversion functions
 
 Wrap all extracted numeric data into safe functions from [`youtube_dl/utils.py`](https://github.com/rg3/youtube-dl/blob/master/youtube_dl/utils.py): `int_or_none`, `float_or_none`. Use them for string to number conversions as well.