Skip to content

Development #120

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathanunderwood merged 7 commits into from
Feb 17, 2018
Merged

Development #120

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3918e28
Fix some Flake8 errors
jonathanunderwood Feb 14, 2018
ca26fe7
Cleanup some docstrings
jonathanunderwood Feb 15, 2018
f4697d2
Merge branch 'master' into development
jonathanunderwood Feb 17, 2018
7b70250
Improve some docstrings
jonathanunderwood Feb 17, 2018
f7698d8
Improve some docstrings
jonathanunderwood Feb 17, 2018
342fba4
Further improve docstrings
jonathanunderwood Feb 17, 2018
4dddd9f
Don't show the doctest directives in quickstart.rst output
jonathanunderwood Feb 17, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ The recommended binding to use is the LZ4 frame format binding, since this
provides interoperability with other implementations and language bindings.

The simplest way to use the frame bindings is via the :py:func:`compress` and
:py:func:`decompress` functions::
:py:func:`decompress` functions:

.. doctest::

Expand All @@ -34,7 +34,7 @@ Working with data in chunks
---------------------------

It's often inconvenient to hold the full data in memory, and so functions are
also provided to compress and decompress data in chunks::
also provided to compress and decompress data in chunks:

.. doctest::

Expand All @@ -61,7 +61,7 @@ can be disabled by specifying ``auto_flush=True`` when calling
time without ending the frame by calling :py:func:`compress_flush` with
``end_frame=False``.

Decompressing data can also be done in a chunked fashion::
Decompressing data can also be done in a chunked fashion:

.. doctest::

Expand All @@ -82,7 +82,7 @@ marker.
Rather than managing compression and decompression context objects manually, it
is more convenient to use the :py:class:`LZ4FrameCompressor` and
:py:class:`LZ4FrameDecompressor` classes which provide context manager
functionality::
functionality:

.. doctest::

Expand All @@ -108,7 +108,7 @@ The frame bindings provide capability for working with files containing LZ4
frame compressed data. This functionality is intended to be a drop in
replacement for that offered in the Python standard library for bz2, gzip and
LZMA compressed files. The :py:func:`lz4.frame.open()` function is the most
convenient way to work with compressed data files::
convenient way to work with compressed data files:

.. doctest::

Expand Down
Loading