added set_as_index input inside add_ids() demo

lshpaner · Jul 30, 2024 · f8213ac · f8213ac
1 parent 6428f90
commit f8213ac
Show file tree

Hide file tree

Showing 5 changed files with 3 additions and 27 deletions.
diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/usage_guide.doctree b/docs/.doctrees/usage_guide.doctree
diff --git a/docs/_sources/usage_guide.rst.txt b/docs/_sources/usage_guide.rst.txt
@@ -161,23 +161,11 @@ column in the dataframe.
         id_colname="census_id",
         num_digits=9,
         seed=111,
-
+        set_as_index=True, 
     )
 
 **Output**
 
-.. .. table::
-
-..    ============  ===  ================  =======  ==========  ==============  ==================  =================  =============
-..    census_id     age  workclass         fnlwgt   education   education-num   marital-status      occupation         relationship
-..    ============  ===  ================  =======  ==========  ==============  ==================  =================  =============
-..    82943611      39   State-gov         77516    Bachelors   13              Never-married       Adm-clerical       Not-in-family
-..    42643227      50   Self-emp-not-inc  83311    Bachelors   13              Married-civ-spouse  Exec-managerial    Husband
-..    93837254      38   Private           215646   HS-grad     9               Divorced            Handlers-cleaners  Not-in-family
-..    87104229      53   Private           234721   11th        7               Married-civ-spouse  Handlers-cleaners  Husband
-..    90069867      28   Private           338409   Bachelors   13              Married-civ-spouse  Prof-specialty     Wife
-..    ============  ===  ================  =======  ==========  ==============  ==================  =================  =============
-
 `First 5 Rows of Census Income Data (Adapted from Kohavi, 1996, UCI Machine Learning Repository)` [1]_
 
 .. raw:: html

diff --git a/docs/usage_guide.html b/docs/usage_guide.html
@@ -224,7 +224,7 @@ <h2>Adding Unique Identifiers<a class="headerlink" href="#adding-unique-identifi
     <span class="n">id_colname</span><span class="o">=</span><span class="s2">&quot;census_id&quot;</span><span class="p">,</span>
     <span class="n">num_digits</span><span class="o">=</span><span class="mi">9</span><span class="p">,</span>
     <span class="n">seed</span><span class="o">=</span><span class="mi">111</span><span class="p">,</span>
-
+    <span class="n">set_as_index</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span>
 <span class="p">)</span>
 </pre></div>
 </div>

diff --git a/source/usage_guide.rst b/source/usage_guide.rst
@@ -161,23 +161,11 @@ column in the dataframe.
         id_colname="census_id",
         num_digits=9,
         seed=111,
-
+        set_as_index=True, 
     )
 
 **Output**
 
-.. .. table::
-
-..    ============  ===  ================  =======  ==========  ==============  ==================  =================  =============
-..    census_id     age  workclass         fnlwgt   education   education-num   marital-status      occupation         relationship
-..    ============  ===  ================  =======  ==========  ==============  ==================  =================  =============
-..    82943611      39   State-gov         77516    Bachelors   13              Never-married       Adm-clerical       Not-in-family
-..    42643227      50   Self-emp-not-inc  83311    Bachelors   13              Married-civ-spouse  Exec-managerial    Husband
-..    93837254      38   Private           215646   HS-grad     9               Divorced            Handlers-cleaners  Not-in-family
-..    87104229      53   Private           234721   11th        7               Married-civ-spouse  Handlers-cleaners  Husband
-..    90069867      28   Private           338409   Bachelors   13              Married-civ-spouse  Prof-specialty     Wife
-..    ============  ===  ================  =======  ==========  ==============  ==================  =================  =============
-
 `First 5 Rows of Census Income Data (Adapted from Kohavi, 1996, UCI Machine Learning Repository)` [1]_
 
 .. raw:: html