Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@bbye98
bbye98 committed Dec 25, 2023
1 parent 8066dda commit cc0db89
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 37 deletions.
Binary file modified docs/.doctrees/environment.pickle
View file
Binary file not shown.
38 changes: 19 additions & 19 deletions docs/_modules/minim/audio.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -197,8 +197,8 @@
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../../api/minim.utility.html">utility</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of utility</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../../api/minim.utility.format_multivalue.html">format_multivalue</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/minim.utility.gestalt_ratios.html">gestalt_ratios</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/minim.utility.levenshtein_ratios.html">levenshtein_ratios</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/minim.utility.gestalt_ratio.html">gestalt_ratio</a></li>
<li class="toctree-l3"><a class="reference internal" href="../../api/minim.utility.levenshtein_ratio.html">levenshtein_ratio</a></li>
</ul>
</li>
</ul>
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 @@ -1417,7 +1417,7 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>
<a class="viewcode-back" href="../../api/minim.audio.FLACAudio.html#minim.audio.FLACAudio">[docs]</a>
<span class="k">class</span> <span class="nc">FLACAudio</span><span class="p">(</span><span class="n">Audio</span><span class="p">,</span> <span class="n">_VorbisComment</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"> FLAC audio file handler.</span>

<span class="sd"> .. seealso::</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 @@ -1497,7 +1497,7 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>
<a class="viewcode-back" href="../../api/minim.audio.MP3Audio.html#minim.audio.MP3Audio">[docs]</a>
<span class="k">class</span> <span class="nc">MP3Audio</span><span class="p">(</span><span class="n">Audio</span><span class="p">,</span> <span class="n">_ID3</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"> MP3 audio file handler.</span>

<span class="sd"> .. seealso::</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 @@ -1576,7 +1576,7 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>
<a class="viewcode-back" href="../../api/minim.audio.MP4Audio.html#minim.audio.MP4Audio">[docs]</a>
<span class="k">class</span> <span class="nc">MP4Audio</span><span class="p">(</span><span class="n">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"> MP4 audio file handler.</span>

<span class="sd"> .. seealso::</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 @@ -1775,7 +1775,7 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>
<a class="viewcode-back" href="../../api/minim.audio.OggAudio.html#minim.audio.OggAudio">[docs]</a>
<span class="k">class</span> <span class="nc">OggAudio</span><span class="p">(</span><span class="n">Audio</span><span class="p">,</span> <span class="n">_VorbisComment</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"> Ogg audio file handler.</span>

<span class="sd"> .. seealso::</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 @@ -1880,7 +1880,7 @@ <h1>Source code for minim.audio</h1><div class="highlight"><pre>
<a class="viewcode-back" href="../../api/minim.audio.WAVEAudio.html#minim.audio.WAVEAudio">[docs]</a>
<span class="k">class</span> <span class="nc">WAVEAudio</span><span class="p">(</span><span class="n">Audio</span><span class="p">,</span> <span class="n">_ID3</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"> WAVE audio file handler.</span>

<span class="sd"> .. seealso::</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/searchindex.js
View file

Large diffs are not rendered by default.

34 changes: 17 additions & 17 deletions src/minim/audio.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -397,9 +397,9 @@ class Audio:
* :code:`("(.*) - (.*)", ("artist", "title"))` matches
filenames like "Taylor Swift - Cruel Summer.flac".
* :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) - (.*)", ("track_number", "title"))` matches
filenames like "04 - The Man.m4a".
* :code:`("(\\d*) (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) (.*)", ("track_number", "title"))` matches
filenames like "13 You Need to Calm Down.mp3".
multivalue : `bool`
Expand Down Expand Up @@ -1158,7 +1158,7 @@ def set_metadata_using_tidal(

class FLACAudio(Audio, _VorbisComment):

"""
r"""
FLAC audio file handler.
.. seealso::
Expand Down Expand Up @@ -1189,9 +1189,9 @@ class FLACAudio(Audio, _VorbisComment):
* :code:`("(.*) - (.*)", ("artist", "title"))` matches
filenames like "Taylor Swift - Fearless.flac".
* :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) - (.*)", ("track_number", "title"))` matches
filenames like "03 - Love Story.flac".
* :code:`("(\\d*) (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) (.*)", ("track_number", "title"))` matches
filenames like "06 You Belong with Me.flac".
multivalue : `bool`
Expand Down Expand Up @@ -1235,7 +1235,7 @@ def __init__(

class MP3Audio(Audio, _ID3):

"""
r"""
MP3 audio file handler.
.. seealso::
Expand Down Expand Up @@ -1266,9 +1266,9 @@ class MP3Audio(Audio, _ID3):
* :code:`("(.*) - (.*)", ("artist", "title"))` matches
filenames like "Taylor Swift - Red.mp3".
* :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) - (.*)", ("track_number", "title"))` matches
filenames like "04 - I Knew You Were Trouble.mp3".
* :code:`("(\\d*) (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) (.*)", ("track_number", "title"))` matches
filenames like "06 22.mp3".
multivalue : `bool`
Expand Down Expand Up @@ -1311,7 +1311,7 @@ def __init__(

class MP4Audio(Audio):

"""
r"""
MP4 audio file handler.
.. seealso::
Expand Down Expand Up @@ -1342,9 +1342,9 @@ class MP4Audio(Audio):
* :code:`("(.*) - (.*)", ("artist", "title"))` matches
filenames like "Taylor Swift - Mine.m4a".
* :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) - (.*)", ("track_number", "title"))` matches
filenames like "04 - Speak Now.m4a".
* :code:`("(\\d*) (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) (.*)", ("track_number", "title"))` matches
filenames like "07 The Story of Us.m4a".
multivalue : `bool`
Expand Down Expand Up @@ -1504,7 +1504,7 @@ def write_metadata(self) -> None:

class OggAudio(Audio, _VorbisComment):

"""
r"""
Ogg audio file handler.
.. seealso::
Expand Down Expand Up @@ -1542,9 +1542,9 @@ class OggAudio(Audio, _VorbisComment):
* :code:`("(.*) - (.*)", ("artist", "title"))` matches
filenames like "Taylor Swift - Blank Space.ogg".
* :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) - (.*)", ("track_number", "title"))` matches
filenames like "03 - Style.ogg".
* :code:`("(\\d*) (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) (.*)", ("track_number", "title"))` matches
filenames like "06 Shake It Off.ogg".
multivalue : `bool`
Expand Down Expand Up @@ -1606,7 +1606,7 @@ def __init__(

class WAVEAudio(Audio, _ID3):

"""
r"""
WAVE audio file handler.
.. seealso::
Expand Down Expand Up @@ -1637,9 +1637,9 @@ class WAVEAudio(Audio, _ID3):
* :code:`("(.*) - (.*)", ("artist", "title"))` matches
filenames like "Taylor Swift - Don't Blame Me.wav".
* :code:`("(\\d*) - (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) - (.*)", ("track_number", "title"))` matches
filenames like "05 - Delicate.wav".
* :code:`("(\\d*) (.*)", ("track_number", "title"))` matches
* :code:`("(\d*) (.*)", ("track_number", "title"))` matches
filenames like "06 Look What You Made Me Do.wav".
multivalue : `bool`
Expand Down

0 comments on commit cc0db89

Please sign in to comment.