Skip to content
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

Remove documentation regarding compression_level=0 #91

Merged
merged 2 commits into from
Apr 2, 2019
Merged

Remove documentation regarding compression_level=0 #91

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7dd1437
Document compression_level range is 1 to 9
addisonElliott Mar 30, 2019
9d2c053
Rewrite compression_level documentation
addisonElliott Mar 30, 2019
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
6 changes: 3 additions & 3 deletions nrrd/writer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,9 @@ def write(filename, data, header=None, detached_header=False, relative_data_path
Dictionary used for parsing custom field types where the key is the custom field name and the value is a
string identifying datatype for the custom field.
compression_level : :class:`int`
Int specifying compression level, when using a compressed encoding (.gz, .bz2).
- For zlib (.gz): 1-9 set low to high compression; 0 disables; -1 uses zlib default.
- For bzip2 (.bz2): 1-9 set low to high compression.
Integer between 1 to 9 specifying the compression level when using a compressed encoding (gzip or bzip). A value
of :obj:`1` compresses the data the least amount and is the fastest, while a value of :obj:`9` compresses the
data the most and is the slowest.

See Also
--------
Expand Down