docs: fixing typo in docs and regenerating

algorandfoundation · Sep 20, 2023 · f0c2790 · f0c2790
1 parent dfb70e2
commit f0c2790
Show file tree

Hide file tree

Showing 10 changed files with 61 additions and 94 deletions.
diff --git a/docs/html/_sources/apidocs/algokit_utils/algokit_utils.md.txt b/docs/html/_sources/apidocs/algokit_utils/algokit_utils.md.txt
@@ -318,6 +318,11 @@ orphan: true
     :parser: myst
     :summary:
     ```
+* - {py:obj}`transfer_asset <algokit_utils._transfer.transfer_asset>`
+  - ```{autodoc2-docstring} algokit_utils._transfer.transfer_asset
+    :parser: myst
+    :summary:
+    ```
 ````
 
 ### Data
@@ -1677,7 +1682,7 @@ Bases: {py:obj}`enum.Enum`
 
 `````
 
-`````{py:class} TransferAssetParameters
+````{py:class} TransferAssetParameters
 :canonical: algokit_utils._transfer.TransferAssetParameters
 
 Bases: {py:obj}`algokit_utils._transfer.TransferParametersBase`
@@ -1686,44 +1691,8 @@ Bases: {py:obj}`algokit_utils._transfer.TransferParametersBase`
 :parser: myst
 ```
 
-````{py:attribute} amount
-:canonical: algokit_utils._transfer.TransferAssetParameters.amount
-:type: int
-:value: >
-   None
-
-```{autodoc2-docstring} algokit_utils._transfer.TransferAssetParameters.amount
-:parser: myst
-```
-
-````
-
-````{py:attribute} asset_id
-:canonical: algokit_utils._transfer.TransferAssetParameters.asset_id
-:type: int
-:value: >
-   None
-
-```{autodoc2-docstring} algokit_utils._transfer.TransferAssetParameters.asset_id
-:parser: myst
-```
-
 ````
 
-````{py:attribute} clawback_from
-:canonical: algokit_utils._transfer.TransferAssetParameters.clawback_from
-:type: algokit_utils.models.Account | str | None
-:value: >
-   None
-
-```{autodoc2-docstring} algokit_utils._transfer.TransferAssetParameters.clawback_from
-:parser: myst
-```
-
-````
-
-`````
-
 ````{py:class} TransferParameters
 :canonical: algokit_utils._transfer.TransferParameters
 
@@ -1929,3 +1898,11 @@ Bases: {py:obj}`algokit_utils._transfer.TransferParametersBase`
 :parser: myst
 ```
 ````
+
+````{py:function} transfer_asset(client: algosdk.v2client.algod.AlgodClient, parameters: algokit_utils._transfer.TransferAssetParameters) -> algosdk.transaction.AssetTransferTxn
+:canonical: algokit_utils._transfer.transfer_asset
+
+```{autodoc2-docstring} algokit_utils._transfer.transfer_asset
+:parser: myst
+```
+````
diff --git a/docs/html/_sources/capabilities/transfer.md.txt b/docs/html/_sources/capabilities/transfer.md.txt
@@ -11,9 +11,9 @@ The key function to facilitate Algo transfers is `algokit.transfer(algod_client,
 
 The following fields on `TransferParameters` are required to transfer ALGOs:
 
-- `from_account`: The account or signer that will send the ALGOs
-- `to_address`: The address of the account that will receive the ALGOs
-- `micro_algos`: The amount of micro ALGOs to send
+-   `from_account`: The account or signer that will send the ALGOs
+-   `to_address`: The address of the account that will receive the ALGOs
+-   `micro_algos`: The amount of micro ALGOs to send
 
 ## Ensuring minimum Algos
 
@@ -22,10 +22,10 @@ The function to facilitate this is `ensure_funded(algod, parameters)`, which tak
 
 The following fields on `EnsureBalanceParameters` are required to ensure minimum ALGOs:
 
-- `account_to_fund`: The account address that will receive the ALGOs
-- `min_spending_balance_micro_algos`: The minimum balance of micro ALGOs that the account should have available to spend (i.e. on top of minimum balance requirement)
-- `min_funding_increment_micro_algos`: When issuing a funding amount, the minimum amount to transfer (avoids many small transfers if this gets called often on an active account)
-- `funding_source`: The account or signer that will send the ALGOs, if not set will use `get_dispenser_account`
+-   `account_to_fund`: The account address that will receive the ALGOs
+-   `min_spending_balance_micro_algos`: The minimum balance of micro ALGOs that the account should have available to spend (i.e. on top of minimum balance requirement)
+-   `min_funding_increment_micro_algos`: When issuing a funding amount, the minimum amount to transfer (avoids many small transfers if this gets called often on an active account)
+-   `funding_source`: The account or signer that will send the ALGOs, if not set will use `get_dispenser_account`
 
 The function calls Algod to find the current balance and minimum balance requirement, gets the difference between those two numbers and checks to see if it's more than the
 `min_spending_balance_micro_algos` and if so then it will send the difference, or the `min_funding_increment_micro_algos` if that is specified.
@@ -36,10 +36,10 @@ The key function to facilitate asset transfers is `transfer_asset(algod_client,
 
 The following fields on `TransferAssetParameters` are required to transfer assets:
 
-- `from_account`: The account or signer that will send the ALGOs
-- `to_address`: The address of the account that will receive the ALGOs
-- `assetID`: The asset id that will be transfered
-- `amount`: The amount to send as the smallest divisible unit value
+-   `from_account`: The account or signer that will send the ALGOs
+-   `to_address`: The address of the account that will receive the ALGOs
+-   `asset_id`: The asset id that will be transfered
+-   `amount`: The amount to send as the smallest divisible unit value
 
 ## Dispenser
 

diff --git a/docs/html/_static/css/theme.css b/docs/html/_static/css/theme.css
diff --git a/docs/html/_static/pygments.css b/docs/html/_static/pygments.css
@@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left:
 .highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
 .highlight .gd { color: #A00000 } /* Generic.Deleted */
 .highlight .ge { font-style: italic } /* Generic.Emph */
+.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
 .highlight .gr { color: #E40000 } /* Generic.Error */
 .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
 .highlight .gi { color: #008400 } /* Generic.Inserted */

diff --git a/docs/html/apidocs/algokit_utils/algokit_utils.html b/docs/html/apidocs/algokit_utils/algokit_utils.html
@@ -123,6 +123,7 @@
 <li class="toctree-l4"><a class="reference internal" href="#algokit_utils.num_extra_program_pages"><code class="docutils literal notranslate"><span class="pre">num_extra_program_pages()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#algokit_utils.replace_template_variables"><code class="docutils literal notranslate"><span class="pre">replace_template_variables()</span></code></a></li>
 <li class="toctree-l4"><a class="reference internal" href="#algokit_utils.transfer"><code class="docutils literal notranslate"><span class="pre">transfer()</span></code></a></li>
+<li class="toctree-l4"><a class="reference internal" href="#algokit_utils.transfer_asset"><code class="docutils literal notranslate"><span class="pre">transfer_asset()</span></code></a></li>
 </ul>
 </li>
 </ul>
@@ -358,6 +359,9 @@ <h3>Functions<a class="headerlink" href="#functions" title="Permalink to this he
 <tr class="row-odd"><td><p><a class="reference internal" href="#algokit_utils.transfer" title="algokit_utils._transfer.transfer"><code class="xref py py-obj docutils literal notranslate"><span class="pre">transfer</span></code></a></p></td>
 <td><p>Transfer µALGOs between accounts</p></td>
 </tr>
+<tr class="row-even"><td><p><a class="reference internal" href="#algokit_utils.transfer_asset" title="algokit_utils._transfer.transfer_asset"><code class="xref py py-obj docutils literal notranslate"><span class="pre">transfer_asset</span></code></a></p></td>
+<td><p>Transfer assets between accounts</p></td>
+</tr>
 </tbody>
 </table>
 </section>
@@ -1293,28 +1297,11 @@ <h3>API<a class="headerlink" href="#api" title="Permalink to this heading"></
 <em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">algokit_utils.</span></span><span class="sig-name descname"><span class="pre">TransferAssetParameters</span></span><a class="headerlink" href="#algokit_utils.TransferAssetParameters" title="Permalink to this definition"></a></dt>
 <dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">algokit_utils._transfer.TransferParametersBase</span></code></p>
 <p>Parameters for transferring assets between accounts</p>
-<dl class="py attribute">
-<dt class="sig sig-object py" id="algokit_utils.TransferAssetParameters.amount">
-<span class="sig-name descname"><span class="pre">amount</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></em><a class="headerlink" href="#algokit_utils.TransferAssetParameters.amount" title="Permalink to this definition"></a></dt>
-<dd><p>None</p>
-<p>The amount to send</p>
-</dd></dl>
-
-<dl class="py attribute">
-<dt class="sig sig-object py" id="algokit_utils.TransferAssetParameters.asset_id">
-<span class="sig-name descname"><span class="pre">asset_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/functions.html#int" title="(in Python v3.11)"><span class="pre">int</span></a></em><a class="headerlink" href="#algokit_utils.TransferAssetParameters.asset_id" title="Permalink to this definition"></a></dt>
-<dd><p>None</p>
-<p>The asset id that will be transfered</p>
-</dd></dl>
-
-<dl class="py attribute">
-<dt class="sig sig-object py" id="algokit_utils.TransferAssetParameters.clawback_from">
-<span class="sig-name descname"><span class="pre">clawback_from</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><a class="reference internal" href="#algokit_utils.Account" title="algokit_utils.models.Account"><span class="pre">algokit_utils.models.Account</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/stdtypes.html#str" title="(in Python v3.11)"><span class="pre">str</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference external" href="https://docs.python.org/3/library/constants.html#None" title="(in Python v3.11)"><span class="pre">None</span></a></em><a class="headerlink" href="#algokit_utils.TransferAssetParameters.clawback_from" title="Permalink to this definition"></a></dt>
-<dd><p>None</p>
-<p>An address of a target account from which to perform a clawback operation. Please note, in such cases
-senderAccount must be equal to clawback field on ASA metadata.</p>
-</dd></dl>
-
+<p>Args:
+asset_id (int): The asset id that will be transfered
+amount (int): The amount to send
+clawback_from (str | None): An address of a target account from which to perform a clawback operation. Please
+note, in such cases senderAccount must be equal to clawback field on ASA metadata.</p>
 </dd></dl>
 
 <dl class="py class">
@@ -1529,6 +1516,12 @@ <h4>Example<a class="headerlink" href="#example" title="Permalink to this headin
 <dd><p>Transfer µALGOs between accounts</p>
 </dd></dl>
 
+<dl class="py function">
+<dt class="sig sig-object py" id="algokit_utils.transfer_asset">
+<span class="sig-prename descclassname"><span class="pre">algokit_utils.</span></span><span class="sig-name descname"><span class="pre">transfer_asset</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">client</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference external" href="https://py-algorand-sdk.readthedocs.io/en/latest/algosdk/v2client/algod.html#algosdk.v2client.algod.AlgodClient" title="(in algosdk)"><span class="pre">algosdk.v2client.algod.AlgodClient</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">parameters</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="#algokit_utils.TransferAssetParameters" title="algokit_utils._transfer.TransferAssetParameters"><span class="pre">algokit_utils._transfer.TransferAssetParameters</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference external" href="https://py-algorand-sdk.readthedocs.io/en/latest/algosdk/transaction.html#algosdk.transaction.AssetTransferTxn" title="(in algosdk)"><span class="pre">algosdk.transaction.AssetTransferTxn</span></a></span></span><a class="headerlink" href="#algokit_utils.transfer_asset" title="Permalink to this definition"></a></dt>
+<dd><p>Transfer assets between accounts</p>
+</dd></dl>
+
 </section>
 </section>
 </section>

diff --git a/docs/html/capabilities/transfer.html b/docs/html/capabilities/transfer.html
@@ -118,7 +118,7 @@ <h2>Transfering Assets<a class="headerlink" href="#transfering-assets" title="Pe
 <ul class="simple">
 <li><p><code class="docutils literal notranslate"><span class="pre">from_account</span></code>: The account or signer that will send the ALGOs</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">to_address</span></code>: The address of the account that will receive the ALGOs</p></li>
-<li><p><code class="docutils literal notranslate"><span class="pre">assetID</span></code>: The asset id that will be transfered</p></li>
+<li><p><code class="docutils literal notranslate"><span class="pre">asset_id</span></code>: The asset id that will be transfered</p></li>
 <li><p><code class="docutils literal notranslate"><span class="pre">amount</span></code>: The amount to send as the smallest divisible unit value</p></li>
 </ul>
 </section>

diff --git a/docs/html/genindex.html b/docs/html/genindex.html
@@ -120,18 +120,16 @@ <h2 id="A">A</h2>
 </li>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.AlgoClientConfig">AlgoClientConfig (class in algokit_utils)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li>
     algokit_utils
 
       <ul>
         <li><a href="apidocs/algokit_utils/algokit_utils.html#module-algokit_utils">module</a>
 </li>
       </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.CallConfig.ALL">ALL (algokit_utils.CallConfig attribute)</a>
-</li>
-      <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.TransferAssetParameters.amount">amount (algokit_utils.TransferAssetParameters attribute)</a>
 </li>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.AppDeployMetaData">AppDeployMetaData (class in algokit_utils)</a>
 </li>
@@ -152,8 +150,6 @@ <h2 id="A">A</h2>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.AppReference">AppReference (class in algokit_utils)</a>
 </li>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.AppSpecStateDict">AppSpecStateDict (in module algokit_utils)</a>
-</li>
-      <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.TransferAssetParameters.asset_id">asset_id (algokit_utils.TransferAssetParameters attribute)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -174,8 +170,6 @@ <h2 id="C">C</h2>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.ApplicationClient.call">call() (algokit_utils.ApplicationClient method)</a>
 </li>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.CallConfig">CallConfig (class in algokit_utils)</a>
-</li>
-      <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.TransferAssetParameters.clawback_from">clawback_from (algokit_utils.TransferAssetParameters attribute)</a>
 </li>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.ApplicationClient.clear_state">clear_state() (algokit_utils.ApplicationClient method)</a>
 </li>
@@ -189,10 +183,10 @@ <h2 id="C">C</h2>
 </li>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.ApplicationClient.compose_create">compose_create() (algokit_utils.ApplicationClient method)</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.ApplicationClient.compose_delete">compose_delete() (algokit_utils.ApplicationClient method)</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.ApplicationClient.compose_opt_in">compose_opt_in() (algokit_utils.ApplicationClient method)</a>
 </li>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.ApplicationClient.compose_update">compose_update() (algokit_utils.ApplicationClient method)</a>
@@ -515,6 +509,8 @@ <h2 id="T">T</h2>
   </ul></td>
   <td style="width: 33%; vertical-align: top;"><ul>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.transfer">transfer() (in module algokit_utils)</a>
+</li>
+      <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.transfer_asset">transfer_asset() (in module algokit_utils)</a>
 </li>
       <li><a href="apidocs/algokit_utils/algokit_utils.html#algokit_utils.TransferAssetParameters">TransferAssetParameters (class in algokit_utils)</a>
 </li>

diff --git a/docs/html/objects.inv b/docs/html/objects.inv
diff --git a/docs/html/searchindex.js b/docs/html/searchindex.js
diff --git a/docs/source/capabilities/transfer.md b/docs/source/capabilities/transfer.md
@@ -11,9 +11,9 @@ The key function to facilitate Algo transfers is `algokit.transfer(algod_client,
 
 The following fields on `TransferParameters` are required to transfer ALGOs:
 
-- `from_account`: The account or signer that will send the ALGOs
-- `to_address`: The address of the account that will receive the ALGOs
-- `micro_algos`: The amount of micro ALGOs to send
+-   `from_account`: The account or signer that will send the ALGOs
+-   `to_address`: The address of the account that will receive the ALGOs
+-   `micro_algos`: The amount of micro ALGOs to send
 
 ## Ensuring minimum Algos
 
@@ -22,10 +22,10 @@ The function to facilitate this is `ensure_funded(algod, parameters)`, which tak
 
 The following fields on `EnsureBalanceParameters` are required to ensure minimum ALGOs:
 
-- `account_to_fund`: The account address that will receive the ALGOs
-- `min_spending_balance_micro_algos`: The minimum balance of micro ALGOs that the account should have available to spend (i.e. on top of minimum balance requirement)
-- `min_funding_increment_micro_algos`: When issuing a funding amount, the minimum amount to transfer (avoids many small transfers if this gets called often on an active account)
-- `funding_source`: The account or signer that will send the ALGOs, if not set will use `get_dispenser_account`
+-   `account_to_fund`: The account address that will receive the ALGOs
+-   `min_spending_balance_micro_algos`: The minimum balance of micro ALGOs that the account should have available to spend (i.e. on top of minimum balance requirement)
+-   `min_funding_increment_micro_algos`: When issuing a funding amount, the minimum amount to transfer (avoids many small transfers if this gets called often on an active account)
+-   `funding_source`: The account or signer that will send the ALGOs, if not set will use `get_dispenser_account`
 
 The function calls Algod to find the current balance and minimum balance requirement, gets the difference between those two numbers and checks to see if it's more than the
 `min_spending_balance_micro_algos` and if so then it will send the difference, or the `min_funding_increment_micro_algos` if that is specified.
@@ -36,10 +36,10 @@ The key function to facilitate asset transfers is `transfer_asset(algod_client,
 
 The following fields on `TransferAssetParameters` are required to transfer assets:
 
-- `from_account`: The account or signer that will send the ALGOs
-- `to_address`: The address of the account that will receive the ALGOs
-- `assetID`: The asset id that will be transfered
-- `amount`: The amount to send as the smallest divisible unit value
+-   `from_account`: The account or signer that will send the ALGOs
+-   `to_address`: The address of the account that will receive the ALGOs
+-   `asset_id`: The asset id that will be transfered
+-   `amount`: The amount to send as the smallest divisible unit value
 
 ## Dispenser