Deploying to gh-pages from @ 99245b2 🚀

Bears-R-Us · Mar 1, 2024 · fc1f02f · fc1f02f
1 parent 0cb5192
commit fc1f02f
Show file tree

Hide file tree

Showing 8 changed files with 14 additions and 15 deletions.
diff --git a/_modules/arkouda/dataframe.html b/_modules/arkouda/dataframe.html
@@ -4737,7 +4737,7 @@ <h1>Source code for arkouda.dataframe</h1><div class="highlight"><pre>
 <a class="viewcode-back" href="../../autoapi/arkouda/index.html#arkouda.dataframe.DataFrame.unregister_dataframe_by_name">[docs]</a>
     <span class="nd">@staticmethod</span>
     <span class="nd">@typechecked</span>
-    <span class="k">def</span> <span class="nf">unregister_dataframe_by_name</span><span class="p">(</span><span class="n">user_defined_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+    <span class="k">def</span> <span class="nf">unregister_dataframe_by_name</span><span class="p">(</span><span class="n">user_defined_name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
 <span class="w">        </span><span class="sd">&quot;&quot;&quot;</span>
 <span class="sd">        Function to unregister DataFrame object by name which was registered</span>
 <span class="sd">        with the arkouda server via register().</span>
@@ -4773,7 +4773,6 @@ <h1>Source code for arkouda.dataframe</h1><div class="highlight"><pre>
 <span class="sd">        &gt;&gt;&gt; df.is_registered()</span>
 <span class="sd">        False</span>
 
-
 <span class="sd">        &quot;&quot;&quot;</span>
         <span class="kn">import</span> <span class="nn">warnings</span>
 

diff --git a/_modules/arkouda/util.html b/_modules/arkouda/util.html
@@ -539,7 +539,7 @@ <h1>Source code for arkouda.util</h1><div class="highlight"><pre>
 <div class="viewcode-block" id="unregister">
 <a class="viewcode-back" href="../../autoapi/arkouda/util/index.html#arkouda.unregister">[docs]</a>
 <span class="nd">@typechecked</span>
-<span class="k">def</span> <span class="nf">unregister</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">):</span>
+<span class="k">def</span> <span class="nf">unregister</span><span class="p">(</span><span class="n">name</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">str</span><span class="p">:</span>
     <span class="n">rep_msg</span> <span class="o">=</span> <span class="n">cast</span><span class="p">(</span><span class="nb">str</span><span class="p">,</span> <span class="n">generic_msg</span><span class="p">(</span><span class="n">cmd</span><span class="o">=</span><span class="s2">&quot;unregister&quot;</span><span class="p">,</span> <span class="n">args</span><span class="o">=</span><span class="p">{</span><span class="s2">&quot;name&quot;</span><span class="p">:</span> <span class="n">name</span><span class="p">}))</span>
 
     <span class="k">return</span> <span class="n">rep_msg</span></div>

diff --git a/_sources/autoapi/arkouda/dataframe/index.rst.txt b/_sources/autoapi/arkouda/dataframe/index.rst.txt
@@ -2177,7 +2177,7 @@ Functions
       False
 
 
-   .. py:method:: unregister_dataframe_by_name(user_defined_name: str) -> None
+   .. py:method:: unregister_dataframe_by_name(user_defined_name: str) -> str
       :staticmethod:
 
       Function to unregister DataFrame object by name which was registered

diff --git a/_sources/autoapi/arkouda/index.rst.txt b/_sources/autoapi/arkouda/index.rst.txt
@@ -2831,7 +2831,7 @@ Attributes
       False
 
 
-   .. py:method:: unregister_dataframe_by_name(user_defined_name: str) -> None
+   .. py:method:: unregister_dataframe_by_name(user_defined_name: str) -> str
       :staticmethod:
 
       Function to unregister DataFrame object by name which was registered
@@ -5073,7 +5073,7 @@ Attributes
       False
 
 
-   .. py:method:: unregister_dataframe_by_name(user_defined_name: str) -> None
+   .. py:method:: unregister_dataframe_by_name(user_defined_name: str) -> str
       :staticmethod:
 
       Function to unregister DataFrame object by name which was registered
@@ -28836,7 +28836,7 @@ Attributes
    array([1, 2, 3])
 
 
-.. py:function:: unregister(name: str)
+.. py:function:: unregister(name: str) -> str
 
 
 .. py:function:: unregister_all(names: list)

diff --git a/_sources/autoapi/arkouda/util/index.rst.txt b/_sources/autoapi/arkouda/util/index.rst.txt
@@ -171,7 +171,7 @@ Functions
    (array([0 1 3 4 6 7 9]), array([10 12 16 4 16 7 28]))
 
 
-.. py:function:: unregister(name: str)
+.. py:function:: unregister(name: str) -> str
 
 
 .. py:function:: unregister_all(names: list)

diff --git a/autoapi/arkouda/dataframe/index.html b/autoapi/arkouda/dataframe/index.html
@@ -3976,7 +3976,7 @@ <h3>Functions<a class="headerlink" href="#functions" title="Link to this heading
 
 <dl class="py method">
 <dt class="sig sig-object py" id="arkouda.dataframe.DataFrame.unregister_dataframe_by_name">
-<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unregister_dataframe_by_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_defined_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../../_modules/arkouda/dataframe.html#DataFrame.unregister_dataframe_by_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arkouda.dataframe.DataFrame.unregister_dataframe_by_name" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unregister_dataframe_by_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_defined_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../../_modules/arkouda/dataframe.html#DataFrame.unregister_dataframe_by_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arkouda.dataframe.DataFrame.unregister_dataframe_by_name" title="Link to this definition">#</a></dt>
 <dd><p>Function to unregister DataFrame object by name which was registered
 with the arkouda server via register().</p>
 <dl class="field-list simple">

diff --git a/autoapi/arkouda/index.html b/autoapi/arkouda/index.html
@@ -1070,7 +1070,7 @@ <h3>Functions<a class="headerlink" href="#functions" title="Link to this heading
 <tr class="row-odd"><td><p><a class="reference internal" href="../../usage/setops.html#arkouda.unique" title="arkouda.unique"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unique</span></code></a>(→ Union[groupable, Tuple[groupable, ...)</p></td>
 <td><p>Find the unique elements of an array.</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="#arkouda.unregister" title="arkouda.unregister"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unregister</span></code></a>(name)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#arkouda.unregister" title="arkouda.unregister"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unregister</span></code></a>(→ str)</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#arkouda.unregister_all" title="arkouda.unregister_all"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unregister_all</span></code></a>(names)</p></td>
@@ -5307,7 +5307,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
 
 <dl class="py method">
 <dt class="sig sig-object py" id="arkouda.DataFrame.unregister_dataframe_by_name">
-<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unregister_dataframe_by_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_defined_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/arkouda/dataframe.html#DataFrame.unregister_dataframe_by_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arkouda.DataFrame.unregister_dataframe_by_name" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unregister_dataframe_by_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_defined_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/arkouda/dataframe.html#DataFrame.unregister_dataframe_by_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arkouda.DataFrame.unregister_dataframe_by_name" title="Link to this definition">#</a></dt>
 <dd><p>Function to unregister DataFrame object by name which was registered
 with the arkouda server via register().</p>
 <dl class="field-list simple">
@@ -9092,7 +9092,7 @@ <h3>Attributes<a class="headerlink" href="#attributes" title="Link to this headi
 
 <dl class="py method">
 <dt class="sig sig-object py" id="id45">
-<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unregister_dataframe_by_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_defined_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="reference internal" href="../../_modules/arkouda/dataframe.html#DataFrame.unregister_dataframe_by_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id45" title="Link to this definition">#</a></dt>
+<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">unregister_dataframe_by_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_defined_name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/arkouda/dataframe.html#DataFrame.unregister_dataframe_by_name"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#id45" title="Link to this definition">#</a></dt>
 <dd><p>Function to unregister DataFrame object by name which was registered
 with the arkouda server via register().</p>
 <dl class="field-list simple">
@@ -39998,7 +39998,7 @@ <h4>Return Type<a class="headerlink" href="#id549" title="Link to this heading">
 
 <dl class="py function">
 <dt class="sig sig-object py" id="arkouda.unregister">
-<span class="sig-prename descclassname"><span class="pre">arkouda.</span></span><span class="sig-name descname"><span class="pre">unregister</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../_modules/arkouda/util.html#unregister"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arkouda.unregister" title="Link to this definition">#</a></dt>
+<span class="sig-prename descclassname"><span class="pre">arkouda.</span></span><span class="sig-name descname"><span class="pre">unregister</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../_modules/arkouda/util.html#unregister"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arkouda.unregister" title="Link to this definition">#</a></dt>
 <dd></dd></dl>
 
 <dl class="py function">

diff --git a/autoapi/arkouda/util/index.html b/autoapi/arkouda/util/index.html
@@ -345,7 +345,7 @@ <h3>Functions<a class="headerlink" href="#functions" title="Link to this heading
 <tr class="row-odd"><td><p><a class="reference internal" href="#arkouda.util.sparse_sum_help" title="arkouda.util.sparse_sum_help"><code class="xref py py-obj docutils literal notranslate"><span class="pre">sparse_sum_help</span></code></a>(idx1, idx2, val1, val2)</p></td>
 <td><p>Helper for summing two sparse matrices together</p></td>
 </tr>
-<tr class="row-even"><td><p><a class="reference internal" href="#arkouda.util.unregister" title="arkouda.util.unregister"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unregister</span></code></a>(name)</p></td>
+<tr class="row-even"><td><p><a class="reference internal" href="#arkouda.util.unregister" title="arkouda.util.unregister"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unregister</span></code></a>(→ str)</p></td>
 <td><p></p></td>
 </tr>
 <tr class="row-odd"><td><p><a class="reference internal" href="#arkouda.util.unregister_all" title="arkouda.util.unregister_all"><code class="xref py py-obj docutils literal notranslate"><span class="pre">unregister_all</span></code></a>(names)</p></td>
@@ -539,7 +539,7 @@ <h3>Functions<a class="headerlink" href="#functions" title="Link to this heading
 
 <dl class="py function">
 <dt class="sig sig-object py" id="arkouda.util.unregister">
-<span class="sig-prename descclassname"><span class="pre">arkouda.util.</span></span><span class="sig-name descname"><span class="pre">unregister</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../../../_modules/arkouda/util.html#unregister"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arkouda.util.unregister" title="Link to this definition">#</a></dt>
+<span class="sig-prename descclassname"><span class="pre">arkouda.util.</span></span><span class="sig-name descname"><span class="pre">unregister</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">name</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="reference internal" href="../../../_modules/arkouda/util.html#unregister"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#arkouda.util.unregister" title="Link to this definition">#</a></dt>
 <dd></dd></dl>
 
 <dl class="py function">