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 Jan 13, 2025
1 parent ecd5a40 commit 7ac6fea
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 18 deletions.
34 changes: 17 additions & 17 deletions docs/fastexcel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ <h2>API Documentation</h2>
<a class="variable" href="#ColumnInfo.index">index</a>
</li>
<li>
<a class="variable" href="#ColumnInfo.column_name_from">column_name_from</a>
<a class="variable" href="#ColumnInfo.dtype_from">dtype_from</a>
</li>
<li>
<a class="variable" href="#ColumnInfo.name">name</a>
Expand All @@ -129,7 +129,7 @@ <h2>API Documentation</h2>
<a class="variable" href="#ColumnInfo.dtype">dtype</a>
</li>
<li>
<a class="variable" href="#ColumnInfo.dtype_from">dtype_from</a>
<a class="variable" href="#ColumnInfo.column_name_from">column_name_from</a>
</li>
</ul>

Expand Down Expand Up @@ -1963,23 +1963,22 @@ <h6 id="parameters">Parameters</h6>


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


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

<div class="docstring"><p><code><a href="#ColumnNameFrom">fastexcel.ColumnNameFrom</a></code>. How the name of the column was determined.</p>
<div class="docstring"><p><code><a href="#DTypeFrom">fastexcel.DTypeFrom</a></code>. How the dtype 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>
<li><code>"provided_by_index"</code>: The dtype was specified via the column index</li>
<li><code>"provided_by_name"</code>: The dtype was specified via the column name</li>
<li><code>"guessed"</code>: The dtype was determined from the content of the column</li>
</ul>
</div>

Expand Down Expand Up @@ -2011,22 +2010,23 @@ <h6 id="parameters">Parameters</h6>


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


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

<div class="docstring"><p><code><a href="#DTypeFrom">fastexcel.DTypeFrom</a></code>. How the dtype of the column was determined.</p>
<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_by_index"</code>: The dtype was specified via the column index</li>
<li><code>"provided_by_name"</code>: The dtype was specified via the column name</li>
<li><code>"guessed"</code>: The dtype was determined from the content of the column</li>
<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>

Expand Down
Loading

0 comments on commit 7ac6fea

Please sign in to comment.