Renaming of parameter p into rel_num_approvals when necessary (better…

… semantics)
COMSOC-Community · Feb 21, 2024 · 4806afb · 4806afb
1 parent 516135e
commit 4806afb
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 10 deletions.
diff --git a/docs-source/source/quickstart.rst b/docs-source/source/quickstart.rst
@@ -121,10 +121,10 @@ Reference: :py:mod:`prefsampling.approval`
      - ---
      - ---
    * - :py:func:`~prefsampling.approval.impartial`
-     - :code:`p`
+     - :code:`rel_num_approvals`
      - ---
    * - :py:func:`~prefsampling.approval.impartial_constant_size`
-     - :code:`num_approvals`
+     - :code:`rel_num_approvals`
      - ---
    * - :py:func:`~prefsampling.approval.resampling`
      - | :code:`p`
@@ -149,7 +149,7 @@ Reference: :py:mod:`prefsampling.approval`
        | :code:`phi`
      - :code:`noise_type` (defaults to :py:const:`~prefsampling.approval.NoiseType.HAMMING`)
    * - :py:func:`~prefsampling.approval.truncated_ordinal`
-     - | :code:`p`
+     - | :code:`rel_num_approvals`
        | :code:`ordinal_sampler`
        | :code:`ordinal_sampler_parameters`
      -

diff --git a/docs/_sources/quickstart.rst b/docs/_sources/quickstart.rst
@@ -121,10 +121,10 @@ Reference: :py:mod:`prefsampling.approval`
      - ---
      - ---
    * - :py:func:`~prefsampling.approval.impartial`
-     - :code:`p`
+     - :code:`rel_num_approvals`
      - ---
    * - :py:func:`~prefsampling.approval.impartial_constant_size`
-     - :code:`num_approvals`
+     - :code:`rel_num_approvals`
      - ---
    * - :py:func:`~prefsampling.approval.resampling`
      - | :code:`p`
@@ -149,7 +149,7 @@ Reference: :py:mod:`prefsampling.approval`
        | :code:`phi`
      - :code:`noise_type` (defaults to :py:const:`~prefsampling.approval.NoiseType.HAMMING`)
    * - :py:func:`~prefsampling.approval.truncated_ordinal`
-     - | :code:`p`
+     - | :code:`rel_num_approvals`
        | :code:`ordinal_sampler`
        | :code:`ordinal_sampler_parameters`
      -

diff --git a/docs/quickstart.html b/docs/quickstart.html
@@ -494,11 +494,11 @@ <h2>Approval Samplers<a class="headerlink" href="#approval-samplers" title="Link
 <td><p>—</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="reference/approval/index.html#prefsampling.approval.impartial" title="prefsampling.approval.impartial"><code class="xref py py-func docutils literal notranslate"><span class="pre">impartial()</span></code></a></p></td>
-<td><p><code class="code docutils literal notranslate"><span class="pre">p</span></code></p></td>
+<td><p><code class="code docutils literal notranslate"><span class="pre">rel_num_approvals</span></code></p></td>
 <td><p>—</p></td>
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="reference/approval/index.html#prefsampling.approval.impartial_constant_size" title="prefsampling.approval.impartial_constant_size"><code class="xref py py-func docutils literal notranslate"><span class="pre">impartial_constant_size()</span></code></a></p></td>
-<td><p><code class="code docutils literal notranslate"><span class="pre">num_approvals</span></code></p></td>
+<td><p><code class="code docutils literal notranslate"><span class="pre">rel_num_approvals</span></code></p></td>
 <td><p>—</p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="reference/approval/index.html#prefsampling.approval.resampling" title="prefsampling.approval.resampling"><code class="xref py py-func docutils literal notranslate"><span class="pre">resampling()</span></code></a></p></td>
@@ -548,7 +548,7 @@ <h2>Approval Samplers<a class="headerlink" href="#approval-samplers" title="Link
 </tr>
 <tr class="row-even"><td><p><a class="reference internal" href="reference/approval/index.html#prefsampling.approval.truncated_ordinal" title="prefsampling.approval.truncated_ordinal"><code class="xref py py-func docutils literal notranslate"><span class="pre">truncated_ordinal()</span></code></a></p></td>
 <td><div class="line-block">
-<div class="line"><code class="code docutils literal notranslate"><span class="pre">p</span></code></div>
+<div class="line"><code class="code docutils literal notranslate"><span class="pre">rel_num_approvals</span></code></div>
 <div class="line"><code class="code docutils literal notranslate"><span class="pre">ordinal_sampler</span></code></div>
 <div class="line"><code class="code docutils literal notranslate"><span class="pre">ordinal_sampler_parameters</span></code></div>
 </div>