Skip to content

Commit

Permalink
Fix cross references in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
salu133445 committed Jan 7, 2020
1 parent 47e7e07 commit d867d06
Show file tree
Hide file tree
Showing 10 changed files with 13 additions and 16 deletions.
3 changes: 1 addition & 2 deletions docs/_modules/pypianoroll/multitrack.html
Original file line number Diff line number Diff line change
Expand Up @@ -1066,8 +1066,7 @@ <h1>Source code for pypianoroll.multitrack</h1><div class="highlight"><pre>
<div class="viewcode-block" id="Multitrack.plot"><a class="viewcode-back" href="../../multitrack.html#pypianoroll.Multitrack.plot">[docs]</a> <span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Plot the pianorolls or save a plot of them. See</span>
<span class="sd"> :func:`pypianoroll.visualization.plot_multitrack` for full</span>
<span class="sd"> documentation.</span>
<span class="sd"> :func:`pypianoroll.plot_multitrack` for full documentation.</span>

<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">plot_multitrack</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
Expand Down
2 changes: 1 addition & 1 deletion docs/_modules/pypianoroll/track.html
Original file line number Diff line number Diff line change
Expand Up @@ -434,7 +434,7 @@ <h1>Source code for pypianoroll.track</h1><div class="highlight"><pre>
<div class="viewcode-block" id="Track.plot"><a class="viewcode-back" href="../../track.html#pypianoroll.Track.plot">[docs]</a> <span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Plot the pianoroll or save a plot of ot. See</span>
<span class="sd"> :func:`pypianoroll.visualization.plot_track` for full documentation.</span>
<span class="sd"> :func:`pypianoroll.plot_track` for full documentation.</span>

<span class="sd"> &quot;&quot;&quot;</span>
<span class="k">return</span> <span class="n">plot_track</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
Expand Down
4 changes: 2 additions & 2 deletions docs/_modules/pypianoroll/utilities.html
Original file line number Diff line number Diff line change
Expand Up @@ -351,8 +351,8 @@ <h1>Source code for pypianoroll.utilities</h1><div class="highlight"><pre>

<div class="viewcode-block" id="plot"><a class="viewcode-back" href="../../visualization.html#pypianoroll.plot">[docs]</a><span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="n">obj</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Plot the object. See :func:`pypianoroll.visualization.plot_multitrack` and</span>
<span class="sd"> :func:`pypianoroll.visualization.plot_track` for full documentation.</span>
<span class="sd"> Plot the object. See :func:`pypianoroll.plot_multitrack` and</span>
<span class="sd"> :func:`pypianoroll.plot_track` for full documentation.</span>

<span class="sd"> &quot;&quot;&quot;</span>
<span class="n">_check_supported</span><span class="p">(</span><span class="n">obj</span><span class="p">)</span>
Expand Down
3 changes: 1 addition & 2 deletions docs/multitrack.html
Original file line number Diff line number Diff line change
Expand Up @@ -653,8 +653,7 @@
<dt id="pypianoroll.Multitrack.plot">
<code class="sig-name descname">plot</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypianoroll/multitrack.html#Multitrack.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypianoroll.Multitrack.plot" title="Permalink to this definition"></a></dt>
<dd><p>Plot the pianorolls or save a plot of them. See
<code class="xref py py-func docutils literal notranslate"><span class="pre">pypianoroll.visualization.plot_multitrack()</span></code> for full
documentation.</p>
<a class="reference internal" href="visualization.html#pypianoroll.plot_multitrack" title="pypianoroll.plot_multitrack"><code class="xref py py-func docutils literal notranslate"><span class="pre">pypianoroll.plot_multitrack()</span></code></a> for full documentation.</p>
</dd></dl>

<dl class="method">
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/track.html
Original file line number Diff line number Diff line change
Expand Up @@ -373,7 +373,7 @@
<dt id="pypianoroll.Track.plot">
<code class="sig-name descname">plot</code><span class="sig-paren">(</span><em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypianoroll/track.html#Track.plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypianoroll.Track.plot" title="Permalink to this definition"></a></dt>
<dd><p>Plot the pianoroll or save a plot of ot. See
<code class="xref py py-func docutils literal notranslate"><span class="pre">pypianoroll.visualization.plot_track()</span></code> for full documentation.</p>
<a class="reference internal" href="visualization.html#pypianoroll.plot_track" title="pypianoroll.plot_track"><code class="xref py py-func docutils literal notranslate"><span class="pre">pypianoroll.plot_track()</span></code></a> for full documentation.</p>
</dd></dl>

<dl class="method">
Expand Down
4 changes: 2 additions & 2 deletions docs/visualization.html
Original file line number Diff line number Diff line change
Expand Up @@ -171,8 +171,8 @@ <h2>Functions<a class="headerlink" href="#functions" title="Permalink to this he
<dl class="function">
<dt id="pypianoroll.plot">
<code class="sig-prename descclassname">pypianoroll.</code><code class="sig-name descname">plot</code><span class="sig-paren">(</span><em class="sig-param">obj</em>, <em class="sig-param">**kwargs</em><span class="sig-paren">)</span><a class="reference internal" href="_modules/pypianoroll/utilities.html#plot"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pypianoroll.plot" title="Permalink to this definition"></a></dt>
<dd><p>Plot the object. See <code class="xref py py-func docutils literal notranslate"><span class="pre">pypianoroll.visualization.plot_multitrack()</span></code> and
<code class="xref py py-func docutils literal notranslate"><span class="pre">pypianoroll.visualization.plot_track()</span></code> for full documentation.</p>
<dd><p>Plot the object. See <a class="reference internal" href="#pypianoroll.plot_multitrack" title="pypianoroll.plot_multitrack"><code class="xref py py-func docutils literal notranslate"><span class="pre">pypianoroll.plot_multitrack()</span></code></a> and
<a class="reference internal" href="#pypianoroll.plot_track" title="pypianoroll.plot_track"><code class="xref py py-func docutils literal notranslate"><span class="pre">pypianoroll.plot_track()</span></code></a> for full documentation.</p>
</dd></dl>

<dl class="function">
Expand Down
3 changes: 1 addition & 2 deletions pypianoroll/multitrack.py
Original file line number Diff line number Diff line change
Expand Up @@ -910,8 +910,7 @@ def parse_pretty_midi(
def plot(self, **kwargs):
"""
Plot the pianorolls or save a plot of them. See
:func:`pypianoroll.visualization.plot_multitrack` for full
documentation.
:func:`pypianoroll.plot_multitrack` for full documentation.
"""
return plot_multitrack(self, **kwargs)
Expand Down
2 changes: 1 addition & 1 deletion pypianoroll/track.py
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ def pad_to_multiple(self, factor):
def plot(self, **kwargs):
"""
Plot the pianoroll or save a plot of ot. See
:func:`pypianoroll.visualization.plot_track` for full documentation.
:func:`pypianoroll.plot_track` for full documentation.
"""
return plot_track(self, **kwargs)
Expand Down
4 changes: 2 additions & 2 deletions pypianoroll/utilities.py
Original file line number Diff line number Diff line change
Expand Up @@ -195,8 +195,8 @@ def parse(filename, beat_resolution=24, name="unknown"):

def plot(obj, **kwargs):
"""
Plot the object. See :func:`pypianoroll.visualization.plot_multitrack` and
:func:`pypianoroll.visualization.plot_track` for full documentation.
Plot the object. See :func:`pypianoroll.plot_multitrack` and
:func:`pypianoroll.plot_track` for full documentation.
"""
_check_supported(obj)
Expand Down

0 comments on commit d867d06

Please sign in to comment.