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.

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

Conversation

addisonElliott
Copy link
Collaborator

@addisonElliott addisonElliott commented Mar 30, 2019

The GZIP library supports a compression level of 0 for no compression but this has been found to be slower than setting the encoding to raw. This PR removes documentation for setting compression_level=0. In addition, bz2 in Python does not support a compression level of 0. Another benefit of this PR is the unified compression level range.

Note that the user can still specify a compression level of 0 at their own risk.

Fixes issue #88

The GZIP library supports compression_level 0 for no compression but this is slower than using the encoding='raw' method. Thus, the documentation was removed for this case. Note that the user can still specify a compression_level of 0 at their own peril.
@codecov-io
Copy link

codecov-io commented Mar 30, 2019

Codecov Report

Merging #91 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #91   +/-   ##
=======================================
  Coverage   99.17%   99.17%           
=======================================
  Files           6        6           
  Lines         363      363           
  Branches      117      117           
=======================================
  Hits          360      360           
  Misses          1        1           
  Partials        2        2
Impacted Files Coverage Δ
nrrd/writer.py 97.47% <ø> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 0dfddeb...9d2c053. Read the comment docs.

@addisonElliott addisonElliott merged commit 77a0af6 into mhe:master Apr 2, 2019
@addisonElliott addisonElliott deleted the remove-encoding-level-0-gzip branch April 2, 2019 16:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants