Skip to content

Commit

Permalink
Replaced weird formatting with strings
Browse files Browse the repository at this point in the history
  • Loading branch information
Kataiser committed Jul 6, 2019
1 parent 9f6e3f8 commit 1c76068
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 3 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/_build/doctrees/guide/funcs.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/_modules/fast_package_file.html
Original file line number Diff line number Diff line change
Expand Up @@ -350,7 +350,7 @@ <h1>Source code for fast_package_file</h1><div class="highlight"><pre>
<span class="sd"> :param compress: Whether to compress the package, either with ``comp_func`` or Gzip by default.</span>
<span class="sd"> :param keep_comp_threshold: 0 through 1 (default is 0.98). For each input file, if compression doesn&#39;t improve file size by this ratio, the file is instead stored uncompressed. Set to 1 to</span>
<span class="sd"> compress every file no matter what.</span>
<span class="sd"> :param hash_mode: The hash method to use to ensure file validity. Can be ``md5`` or ``sha256``. If :py:class:`None` (the default), only the first and last bytes are compared.</span>
<span class="sd"> :param hash_mode: The hash method to use to ensure file validity. Can be &quot;md5&quot; or &quot;sha256&quot;. If :py:class:`None` (the default), only the first and last bytes are compared.</span>
<span class="sd"> :param comp_func: A supplied decompression function that takes :py:class:`bytes` and returns :py:class:`bytes`. Some recommendations: LZMA, LZMA2, Deflate, BZip2, Oodle, or Zstandard.</span>
<span class="sd"> :param progress_bar: Whether to show a progress bar (uses `tqdm &lt;https://github.com/tqdm/tqdm&gt;`_). If tqdm isn&#39;t installed, this is irrelevant.</span>
<span class="sd"> :param silent: Disable all prints.</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/_build/html/guide/funcs.html
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ <h1>Function reference<a class="headerlink" href="#function-reference" title="Pe
<li><p><strong>compress</strong> – Whether to compress the package, either with <code class="docutils literal notranslate"><span class="pre">comp_func</span></code> or Gzip by default.</p></li>
<li><p><strong>keep_comp_threshold</strong> – 0 through 1 (default is 0.98). For each input file, if compression doesn’t improve file size by this ratio, the file is instead stored uncompressed. Set to 1 to
compress every file no matter what.</p></li>
<li><p><strong>hash_mode</strong> – The hash method to use to ensure file validity. Can be <code class="docutils literal notranslate"><span class="pre">md5</span></code> or <code class="docutils literal notranslate"><span class="pre">sha256</span></code>. If <code class="xref py py-class docutils literal notranslate"><span class="pre">None</span></code> (the default), only the first and last bytes are compared.</p></li>
<li><p><strong>hash_mode</strong> – The hash method to use to ensure file validity. Can be md5 or sha256. If <code class="xref py py-class docutils literal notranslate"><span class="pre">None</span></code> (the default), only the first and last bytes are compared.</p></li>
<li><p><strong>comp_func</strong> – A supplied decompression function that takes <code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code> and returns <code class="xref py py-class docutils literal notranslate"><span class="pre">bytes</span></code>. Some recommendations: LZMA, LZMA2, Deflate, BZip2, Oodle, or Zstandard.</p></li>
<li><p><strong>progress_bar</strong> – Whether to show a progress bar (uses <a class="reference external" href="https://github.com/tqdm/tqdm">tqdm</a>). If tqdm isn’t installed, this is irrelevant.</p></li>
<li><p><strong>silent</strong> – Disable all prints.</p></li>
Expand Down
2 changes: 1 addition & 1 deletion fast_package_file/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@ def build(directory: str, target: str, compress: bool = True, keep_comp_threshol
:param compress: Whether to compress the package, either with ``comp_func`` or Gzip by default.
:param keep_comp_threshold: 0 through 1 (default is 0.98). For each input file, if compression doesn't improve file size by this ratio, the file is instead stored uncompressed. Set to 1 to
compress every file no matter what.
:param hash_mode: The hash method to use to ensure file validity. Can be ``md5`` or ``sha256``. If :py:class:`None` (the default), only the first and last bytes are compared.
:param hash_mode: The hash method to use to ensure file validity. Can be "md5" or "sha256". If :py:class:`None` (the default), only the first and last bytes are compared.
:param comp_func: A supplied decompression function that takes :py:class:`bytes` and returns :py:class:`bytes`. Some recommendations: LZMA, LZMA2, Deflate, BZip2, Oodle, or Zstandard.
:param progress_bar: Whether to show a progress bar (uses `tqdm <https://github.com/tqdm/tqdm>`_). If tqdm isn't installed, this is irrelevant.
:param silent: Disable all prints.
Expand Down

0 comments on commit 1c76068

Please sign in to comment.