Skip to content

Commit

Permalink
Re-generated documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions committed Sep 30, 2024
1 parent b05a7be commit f662348
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 36 deletions.
70 changes: 35 additions & 35 deletions docs/fastexcel.html
Original file line number Diff line number Diff line change
Expand Up @@ -117,19 +117,19 @@ <h2>API Documentation</h2>
<a class="class" href="#ColumnInfo">ColumnInfo</a>
<ul class="memberlist">
<li>
<a class="variable" href="#ColumnInfo.dtype_from">dtype_from</a>
<a class="variable" href="#ColumnInfo.column_name_from">column_name_from</a>
</li>
<li>
<a class="variable" href="#ColumnInfo.index">index</a>
<a class="variable" href="#ColumnInfo.dtype_from">dtype_from</a>
</li>
<li>
<a class="variable" href="#ColumnInfo.name">name</a>
<a class="variable" href="#ColumnInfo.dtype">dtype</a>
</li>
<li>
<a class="variable" href="#ColumnInfo.dtype">dtype</a>
<a class="variable" href="#ColumnInfo.name">name</a>
</li>
<li>
<a class="variable" href="#ColumnInfo.column_name_from">column_name_from</a>
<a class="variable" href="#ColumnInfo.index">index</a>
</li>
</ul>

Expand Down Expand Up @@ -1920,6 +1920,28 @@ <h6 id="parameters">Parameters</h6>
</div>


<div id="ColumnInfo.column_name_from" class="classattr">
<div class="attr variable">
<span class="name">column_name_from</span>


</div>
<a class="headerlink" href="#ColumnInfo.column_name_from"></a>

<div class="docstring"><p><code><a href="#ColumnNameFrom">fastexcel.ColumnNameFrom</a></code>. How the name of the column was determined.</p>

<p>One of three possible values:</p>

<ul>
<li><code>"provided"</code>: The column name was provided via the <code>use_columns</code> parameter</li>
<li><code>"looked_up"</code>: The column name was looked up from the data found in the sheet</li>
<li><code>"generated"</code>: The column name was generated from the column index, either because
<code>header_row</code> was <code>None</code>, or because it could not be looked up</li>
</ul>
</div>


</div>
<div id="ColumnInfo.dtype_from" class="classattr">
<div class="attr variable">
<span class="name">dtype_from</span>
Expand All @@ -1941,15 +1963,15 @@ <h6 id="parameters">Parameters</h6>


</div>
<div id="ColumnInfo.index" class="classattr">
<div id="ColumnInfo.dtype" class="classattr">
<div class="attr variable">
<span class="name">index</span>
<span class="name">dtype</span>


</div>
<a class="headerlink" href="#ColumnInfo.index"></a>
<a class="headerlink" href="#ColumnInfo.dtype"></a>

<div class="docstring"><p><code>int</code>. The index of the column</p>
<div class="docstring"><p><code><a href="#DType">fastexcel.DType</a></code>. The dtype of the column</p>
</div>


Expand All @@ -1967,37 +1989,15 @@ <h6 id="parameters">Parameters</h6>


</div>
<div id="ColumnInfo.dtype" class="classattr">
<div class="attr variable">
<span class="name">dtype</span>


</div>
<a class="headerlink" href="#ColumnInfo.dtype"></a>

<div class="docstring"><p><code><a href="#DType">fastexcel.DType</a></code>. The dtype of the column</p>
</div>


</div>
<div id="ColumnInfo.column_name_from" class="classattr">
<div id="ColumnInfo.index" class="classattr">
<div class="attr variable">
<span class="name">column_name_from</span>
<span class="name">index</span>


</div>
<a class="headerlink" href="#ColumnInfo.column_name_from"></a>
<a class="headerlink" href="#ColumnInfo.index"></a>

<div class="docstring"><p><code><a href="#ColumnNameFrom">fastexcel.ColumnNameFrom</a></code>. How the name of the column was determined.</p>

<p>One of three possible values:</p>

<ul>
<li><code>"provided"</code>: The column name was provided via the <code>use_columns</code> parameter</li>
<li><code>"looked_up"</code>: The column name was looked up from the data found in the sheet</li>
<li><code>"generated"</code>: The column name was generated from the column index, either because
<code>header_row</code> was <code>None</code>, or because it could not be looked up</li>
</ul>
<div class="docstring"><p><code>int</code>. The index of the column</p>
</div>


Expand Down
Loading

0 comments on commit f662348

Please sign in to comment.