github/streamlink
1
Fork 0
mirror of https://github.com/streamlink/streamlink synced 2024-11-14 01:04:54 +01:00
Code Releases Activity

docs: add new line before codeblock to fix them

Browse Source 
A codeblock without an empty new line before cause bad docs generation
in man and html formats.

This causes a `man` warning: `warning: macro `.' not defined`.
The manpage contains `.. code\-block:: console` which it does not
recognize.

In html format, the  generated line is
`For example: .. code-block:: console` and the following codeblock is
not correctly formatted.
This commit is contained in:
Alexis Murzeau 2017-09-17 23:21:26 +02:00
parent ccde01f6e8
commit e20fa0bc9d
1 changed files with 1 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/cli.rst
View File

@ -340,6 +340,7 @@ options if the plugin you use makes HTTP and HTTPS requests.
Both HTTP and SOCKS5 proxies are supported, authentication is supported for both types. Both HTTP and SOCKS5 proxies are supported, authentication is supported for both types.
For example: For example:
.. code-block:: console .. code-block:: console
$ streamlink --http-proxy "http://user:pass@10.10.1.10:3128/" --https-proxy "socks5://10.10.1.10:1242" $ streamlink --http-proxy "http://user:pass@10.10.1.10:3128/" --https-proxy "socks5://10.10.1.10:1242"