Skip to content

Commit

Permalink
docs: Remove newlines babble from quickstart
Browse files Browse the repository at this point in the history
This is more likely to just confuse people than actually do anything
useful.
  • Loading branch information
cdown committed Jul 22, 2020
1 parent 11f06e6 commit 97a4ee5
Showing 1 changed file with 0 additions and 16 deletions.
16 changes: 0 additions & 16 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,19 +47,3 @@ Compose an SRT from Python objects
we dig a tunnel under the city and release it into the wild.
<BLANKLINE>
<BLANKLINE>
Newlines
--------

srt accepts ``\r\n`` line endings, but converts them to ``\n`` internally. One
reason for this is because it's impossible for srt to know whether you're using
universal newlines, and even if you're not, whether you're going to write in
text mode or binary mode.

As such, if you want output with a line ending *other* than ``\n``, it's your
responsibility to do something like this (the default ``eol`` is ``\n`` for
these reasons).

.. code:: python
srt.compose(subs, eol=os.linesep)

0 comments on commit 97a4ee5

Please sign in to comment.