Skip to content

Commit

Permalink
Fix non-escaped backslash in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@bbye98
bbye98 committed Dec 25, 2023
1 parent cc0db89 commit c137b95
Show file tree
Hide file tree
Showing 26 changed files with 82 additions and 660 deletions.
Binary file modified docs/.doctrees/api/minim.audio.Audio.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/minim.audio.FLACAudio.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/minim.audio.MP3Audio.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/minim.audio.MP4Audio.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/minim.audio.OGGAudio.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/api/minim.audio.WAVEAudio.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/.doctrees/notebooks/getting_started.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/notebooks/user_guide/editing_audio_metadata.doctree
View file
Binary file not shown.
Binary file modified docs/.doctrees/notebooks/user_guide/getting_recommendations.doctree
View file
Binary file not shown.
32 changes: 16 additions & 16 deletions docs/_modules/minim/audio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -587,7 +587,7 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>
<a class="viewcode-back" href="../../api/minim.audio.Audio.html#minim.audio.Audio">[docs]</a>
<span class="k">class</span> <span class="nc">Audio</span><span class="p">:</span>

<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="w"> </span><span class="sa">r</span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Generic audio file handler.</span>

<span class="sd"> Subclasses for specific audio containers or formats include</span>
Expand All @@ -601,7 +601,7 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>
<span class="sd"> Audio Codec (ALAC), or stored in a MPEG-4 Part 14 (MP4, M4A)</span>
<span class="sd"> container,</span>
<span class="sd"> * :class:`OggAudio` for Opus or Vorbis audio stored in an Ogg file,</span>
<span class="sd"> or</span>
<span class="sd"> and</span>
<span class="sd"> * :class:`WAVEAudio` for audio encoded using linear pulse-code </span>
<span class="sd"> modulation (LPCM) and in the Waveform Audio File Format (WAVE).</span>

Expand Down Expand Up @@ -638,9 +638,9 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>

<span class="sd"> * :code:`(&quot;(.*) - (.*)&quot;, (&quot;artist&quot;, &quot;title&quot;))` matches </span>
<span class="sd"> filenames like &quot;Taylor Swift - Cruel Summer.flac&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;04 - The Man.m4a&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;13 You Need to Calm Down.mp3&quot;.</span>

<span class="sd"> multivalue : `bool`</span>
Expand Down Expand Up @@ -1448,9 +1448,9 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>

<span class="sd"> * :code:`(&quot;(.*) - (.*)&quot;, (&quot;artist&quot;, &quot;title&quot;))` matches </span>
<span class="sd"> filenames like &quot;Taylor Swift - Fearless.flac&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;03 - Love Story.flac&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;06 You Belong with Me.flac&quot;.</span>

<span class="sd"> multivalue : `bool`</span>
Expand Down Expand Up @@ -1528,9 +1528,9 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>

<span class="sd"> * :code:`(&quot;(.*) - (.*)&quot;, (&quot;artist&quot;, &quot;title&quot;))` matches </span>
<span class="sd"> filenames like &quot;Taylor Swift - Red.mp3&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;04 - I Knew You Were Trouble.mp3&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;06 22.mp3&quot;.</span>

<span class="sd"> multivalue : `bool`</span>
Expand Down Expand Up @@ -1607,9 +1607,9 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>

<span class="sd"> * :code:`(&quot;(.*) - (.*)&quot;, (&quot;artist&quot;, &quot;title&quot;))` matches </span>
<span class="sd"> filenames like &quot;Taylor Swift - Mine.m4a&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;04 - Speak Now.m4a&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;07 The Story of Us.m4a&quot;.</span>

<span class="sd"> multivalue : `bool`</span>
Expand Down Expand Up @@ -1702,8 +1702,8 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>
<span class="n">value</span> <span class="o">=</span> <span class="kc">None</span>
<span class="nb">setattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>

<span class="bp">self</span><span class="o">.</span><span class="n">isrc</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tags</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;----:com.apple.iTunes:ISRC&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span> \
<span class="k">if</span> <span class="s2">&quot;----:com.apple.iTunes:ISRC&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tags</span> <span class="k">else</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">isrc</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">_tags</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;----:com.apple.iTunes:ISRC&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span><span class="o">.</span><span class="n">decode</span><span class="p">()</span>
<span class="k">if</span> <span class="s2">&quot;----:com.apple.iTunes:ISRC&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tags</span> <span class="k">else</span> <span class="kc">None</span><span class="p">)</span>

<span class="k">if</span> <span class="s2">&quot;disk&quot;</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tags</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">disc_number</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">disc_count</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_tags</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;disk&quot;</span><span class="p">)[</span><span class="mi">0</span><span class="p">]</span>
Expand Down Expand Up @@ -1813,9 +1813,9 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>

<span class="sd"> * :code:`(&quot;(.*) - (.*)&quot;, (&quot;artist&quot;, &quot;title&quot;))` matches </span>
<span class="sd"> filenames like &quot;Taylor Swift - Blank Space.ogg&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;03 - Style.ogg&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;06 Shake It Off.ogg&quot;.</span>

<span class="sd"> multivalue : `bool`</span>
Expand Down Expand Up @@ -1911,9 +1911,9 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>

<span class="sd"> * :code:`(&quot;(.*) - (.*)&quot;, (&quot;artist&quot;, &quot;title&quot;))` matches </span>
<span class="sd"> filenames like &quot;Taylor Swift - Don&#39;t Blame Me.wav&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) - (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;05 - Delicate.wav&quot;.</span>
<span class="sd"> * :code:`(&quot;(\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> * :code:`(&quot;(\\d*) (.*)&quot;, (&quot;track_number&quot;, &quot;title&quot;))` matches</span>
<span class="sd"> filenames like &quot;06 Look What You Made Me Do.wav&quot;.</span>

<span class="sd"> multivalue : `bool`</span>
Expand Down
2 changes: 1 addition & 1 deletion docs/_sources/api/minim.utility.rst.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
utility
utility
=======

.. automodule:: minim.utility
Expand Down
6 changes: 3 additions & 3 deletions docs/api/minim.audio.Audio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ <h1>Audio<a class="headerlink" href="#audio" title="Link to this heading">#</a><
Audio Codec (ALAC), or stored in a MPEG-4 Part 14 (MP4, M4A)
container,</p></li>
<li><p><a class="reference internal" href="minim.audio.OggAudio.html#minim.audio.OggAudio" title="minim.audio.OggAudio"><code class="xref py py-class docutils literal notranslate"><span class="pre">OggAudio</span></code></a> for Opus or Vorbis audio stored in an Ogg file,
or</p></li>
and</p></li>
<li><p><a class="reference internal" href="minim.audio.WAVEAudio.html#minim.audio.WAVEAudio" title="minim.audio.WAVEAudio"><code class="xref py py-class docutils literal notranslate"><span class="pre">WAVEAudio</span></code></a> for audio encoded using linear pulse-code
modulation (LPCM) and in the Waveform Audio File Format (WAVE).</p></li>
</ul>
Expand Down Expand Up @@ -289,9 +289,9 @@ <h1>Audio<a class="headerlink" href="#audio" title="Link to this heading">#</a><
<ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(.*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;artist&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “Taylor Swift - Cruel Summer.flac”.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(d*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(\d*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “04 - The Man.m4a”.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(d*)</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(\d*)</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “13 You Need to Calm Down.mp3”.</p></li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/minim.audio.FLACAudio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,9 @@ <h1>FLACAudio<a class="headerlink" href="#flacaudio" title="Link to this heading
<ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(.*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;artist&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “Taylor Swift - Fearless.flac”.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(d*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(\d*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “03 - Love Story.flac”.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(d*)</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(\d*)</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “06 You Belong with Me.flac”.</p></li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/minim.audio.MP3Audio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,9 @@ <h1>MP3Audio<a class="headerlink" href="#mp3audio" title="Link to this heading">
<ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(.*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;artist&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “Taylor Swift - Red.mp3”.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(d*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(\d*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “04 - I Knew You Were Trouble.mp3”.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(d*)</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(\d*)</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “06 22.mp3”.</p></li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/minim.audio.MP4Audio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -269,9 +269,9 @@ <h1>MP4Audio<a class="headerlink" href="#mp4audio" title="Link to this heading">
<ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(.*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;artist&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “Taylor Swift - Mine.m4a”.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(d*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(\d*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “04 - Speak Now.m4a”.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(d*)</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(\d*)</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “07 The Story of Us.m4a”.</p></li>
</ul>
</div>
Expand Down
4 changes: 2 additions & 2 deletions docs/api/minim.audio.OGGAudio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -274,9 +274,9 @@ <h1>OggAudio<a class="headerlink" href="#oggaudio" title="Link to this heading">
<ul class="simple">
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(.*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;artist&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “Taylor Swift - Blank Space.ogg”.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(d*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(\d*)</span> <span class="pre">-</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “03 - Style.ogg”.</p></li>
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(d*)</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
<li><p><code class="code docutils literal notranslate"><span class="pre">(&quot;(\d*)</span> <span class="pre">(.*)&quot;,</span> <span class="pre">(&quot;track_number&quot;,</span> <span class="pre">&quot;title&quot;))</span></code> matches
filenames like “06 Shake It Off.ogg”.</p></li>
</ul>
</div>
Expand Down
Loading

0 comments on commit c137b95

Please sign in to comment.