docs: docstring examples

Author: aorumbayev

docs/markdown/autoapi/algokit_utils/applications/abi/index.md

@@ -43,24 +43,26 @@ Represents the return value from an ABI method call.
 
 Wraps the raw return value and decoded value along with any decode errors.
 
-* **Variables:**
-  * **result** – The ABIResult object containing the method call results
-  * **raw_value** – The raw return value from the method call
-  * **value** – The decoded return value from the method call
-  * **method** – The ABI method definition
-  * **decode_error** – The exception that occurred during decoding, if any
-  * **tx_info** – The transaction info for the method call from raw algosdk ABIResult
-
 #### raw_value *: bytes | None* *= None*
 
+The raw return value from the method call
+
 #### value *: ABIValue | None* *= None*
 
+The decoded return value from the method call
+
 #### method *: algosdk.abi.method.Method | None* *= None*
 
+The ABI method definition
+
 #### decode_error *: Exception | None* *= None*
 
+The exception that occurred during decoding, if any
+
 #### tx_info *: dict[str, Any] | None* *= None*
 
+The transaction info for the method call from raw algosdk ABIResult
+
 #### *property* is_success *: bool*
 
 Returns True if the ABI call was successful (no decode error)
@@ -155,10 +157,10 @@ Converts a decoded tuple to an ABI struct.
 
 Represents an ABI value stored in a box.
 
-* **Variables:**
-  * **name** – The name of the box
-  * **value** – The ABI value stored in the box
-
 #### name *: [algokit_utils.models.state.BoxName](../../models/state/index.md#algokit_utils.models.state.BoxName)*
 
+The name of the box
+
 #### value *: ABIValue*
+
+The ABI value stored in the box

docs/markdown/autoapi/algokit_utils/applications/app_client/index.md

@@ -48,20 +48,22 @@ Result of compiling an application’s TEAL code.
 
 Contains the compiled approval and clear state programs along with optional compilation artifacts.
 
-* **Variables:**
-  * **approval_program** – The compiled approval program bytes
-  * **clear_state_program** – The compiled clear state program bytes
-  * **compiled_approval** – Optional compilation artifacts for approval program
-  * **compiled_clear** – Optional compilation artifacts for clear state program
-
 #### approval_program *: bytes*
 
+The compiled approval program bytes
+
 #### clear_state_program *: bytes*
 
+The compiled clear state program bytes
+
 #### compiled_approval *: [algokit_utils.models.application.CompiledTeal](../../models/application/index.md#algokit_utils.models.application.CompiledTeal) | None* *= None*
 
+Optional compilation artifacts for approval program
+
 #### compiled_clear *: [algokit_utils.models.application.CompiledTeal](../../models/application/index.md#algokit_utils.models.application.CompiledTeal) | None* *= None*
 
+Optional compilation artifacts for clear state program
+
 ### *class* algokit_utils.applications.app_client.AppClientCompilationParams
 
 Bases: `TypedDict`
@@ -83,67 +85,82 @@ Parameters for compiling an application’s TEAL code.
 
 Common configuration for app call transaction parameters
 
-* **Variables:**
-  * **account_references** – List of account addresses to reference
-  * **app_references** – List of app IDs to reference
-  * **asset_references** – List of asset IDs to reference
-  * **box_references** – List of box references to include
-  * **extra_fee** – Additional fee to add to transaction
-  * **lease** – Transaction lease value
-  * **max_fee** – Maximum fee allowed for transaction
-  * **note** – Arbitrary note for the transaction
-  * **rekey_to** – Address to rekey account to
-  * **sender** – Sender address override
-  * **signer** – Custom transaction signer
-  * **static_fee** – Fixed fee for transaction
-  * **validity_window** – Number of rounds valid
-  * **first_valid_round** – First valid round number
-  * **last_valid_round** – Last valid round number
-
 #### account_references *: list[str] | None* *= None*
 
+List of account addresses to reference
+
 #### app_references *: list[int] | None* *= None*
 
+List of app IDs to reference
+
 #### asset_references *: list[int] | None* *= None*
 
+List of asset IDs to reference
+
 #### box_references *: list[[algokit_utils.models.state.BoxReference](../../models/state/index.md#algokit_utils.models.state.BoxReference) | algokit_utils.models.state.BoxIdentifier] | None* *= None*
 
+List of box references to include
+
 #### extra_fee *: [algokit_utils.models.amount.AlgoAmount](../../models/amount/index.md#algokit_utils.models.amount.AlgoAmount) | None* *= None*
 
+Additional fee to add to transaction
+
 #### lease *: bytes | None* *= None*
 
+Transaction lease value
+
 #### max_fee *: [algokit_utils.models.amount.AlgoAmount](../../models/amount/index.md#algokit_utils.models.amount.AlgoAmount) | None* *= None*
 
+Maximum fee allowed for transaction
+
 #### note *: bytes | None* *= None*
 
+Custom note for the transaction
+
 #### rekey_to *: str | None* *= None*
 
+Address to rekey account to
+
 #### sender *: str | None* *= None*
 
+Sender address override
+
 #### signer *: algosdk.atomic_transaction_composer.TransactionSigner | None* *= None*
 
+Custom transaction signer
+
 #### static_fee *: [algokit_utils.models.amount.AlgoAmount](../../models/amount/index.md#algokit_utils.models.amount.AlgoAmount) | None* *= None*
 
+Fixed fee for transaction
+
 #### validity_window *: int | None* *= None*
 
+Number of rounds valid
+
 #### first_valid_round *: int | None* *= None*
 
+First valid round number
+
 #### last_valid_round *: int | None* *= None*
 
+Last valid round number
+
 #### on_complete *: algosdk.transaction.OnComplete | None* *= None*
 
+Optional on complete action
+
 ### *class* algokit_utils.applications.app_client.AppClientCreateSchema
 
 Schema for application creation.
 
-* **Variables:**
-  * **extra_program_pages** – Optional number of extra program pages
-  * **schema** – Optional application creation schema
-
 #### extra_program_pages *: int | None* *= None*
 
+Optional number of extra program pages
+
 #### schema *: [algokit_utils.transactions.transaction_composer.AppCreateSchema](../../transactions/transaction_composer/index.md#algokit_utils.transactions.transaction_composer.AppCreateSchema) | None* *= None*
 
+Optional application creation schema
+
 ### *class* algokit_utils.applications.app_client.CommonAppCallCreateParams
 
 Bases: [`AppClientCreateSchema`](#algokit_utils.applications.app_client.AppClientCreateSchema), [`CommonAppCallParams`](#algokit_utils.applications.app_client.CommonAppCallParams)
@@ -152,31 +169,32 @@ Common configuration for app create call transaction parameters.
 
 #### on_complete *: CreateOnComplete | None* *= None*
 
+Optional on complete action
+
 ### *class* algokit_utils.applications.app_client.FundAppAccountParams
 
 Bases: [`CommonAppCallParams`](#algokit_utils.applications.app_client.CommonAppCallParams)
 
 Parameters for funding an application’s account.
 
-* **Variables:**
-  * **amount** – Amount to fund
-  * **close_remainder_to** – Optional address to close remainder to
-
 #### amount *: [algokit_utils.models.amount.AlgoAmount](../../models/amount/index.md#algokit_utils.models.amount.AlgoAmount)*
 
+Amount to fund
+
 #### close_remainder_to *: str | None* *= None*
 
+Optional address to close remainder to
+
 ### *class* algokit_utils.applications.app_client.AppClientBareCallParams
 
 Bases: [`CommonAppCallParams`](#algokit_utils.applications.app_client.CommonAppCallParams)
 
 Parameters for bare application calls.
 
-* **Variables:**
-  **args** – Optional arguments
-
 #### args *: list[bytes] | None* *= None*
 
+Optional arguments
+
 ### *class* algokit_utils.applications.app_client.AppClientBareCallCreateParams
 
 Bases: [`CommonAppCallCreateParams`](#algokit_utils.applications.app_client.CommonAppCallCreateParams)
@@ -185,21 +203,22 @@ Parameters for creating application with bare call.
 
 #### on_complete *: CreateOnComplete | None* *= None*
 
+Optional on complete action
+
 ### *class* algokit_utils.applications.app_client.BaseAppClientMethodCallParams
 
 Bases: `Generic`[`ArgsT`, `MethodT`], [`CommonAppCallParams`](#algokit_utils.applications.app_client.CommonAppCallParams)
 
 Base parameters for application method calls.
 
-* **Variables:**
-  * **method** – Method to call
-  * **args** – Optional arguments to pass to method
-  * **on_complete** – Optional on complete action
-
 #### method *: MethodT*
 
+Method to call
+
 #### args *: ArgsT | None* *= None*
 
+Arguments to pass to the application method call
+
 ### *class* algokit_utils.applications.app_client.AppClientMethodCallParams
 
 Bases: [`BaseAppClientMethodCallParams`](#algokit_utils.applications.app_client.BaseAppClientMethodCallParams)[`collections.abc.Sequence`[`algokit_utils.applications.abi.ABIValue | algokit_utils.applications.abi.ABIStruct | algokit_utils.transactions.transaction_composer.AppMethodCallTransactionArgument | None`], `str`]
@@ -214,26 +233,44 @@ Parameters for creating application with method call
 
 #### on_complete *: CreateOnComplete | None* *= None*
 
+Optional on complete action
+
 ### *class* algokit_utils.applications.app_client.AppClientParams
 
 Full parameters for creating an app client
 
 #### app_spec *: [algokit_utils.applications.app_spec.arc56.Arc56Contract](../app_spec/arc56/index.md#algokit_utils.applications.app_spec.arc56.Arc56Contract) | [algokit_utils.applications.app_spec.arc32.Arc32Contract](../app_spec/arc32/index.md#algokit_utils.applications.app_spec.arc32.Arc32Contract) | str*
 
+The application specification
+
 #### algorand *: [algokit_utils.algorand.AlgorandClient](../../algorand/index.md#algokit_utils.algorand.AlgorandClient)*
 
+The Algorand client
+
 #### app_id *: int*
 
+The application ID
+
 #### app_name *: str | None* *= None*
 
+The application name
+
 #### default_sender *: str | None* *= None*
 
+The default sender address
+
 #### default_signer *: algosdk.atomic_transaction_composer.TransactionSigner | None* *= None*
 
+The default transaction signer
+
 #### approval_source_map *: algosdk.source_map.SourceMap | None* *= None*
 
+The approval source map
+
 #### clear_source_map *: algosdk.source_map.SourceMap | None* *= None*
 
+The clear source map
+
 ### *class* algokit_utils.applications.app_client.AppClient(params: [AppClientParams](#algokit_utils.applications.app_client.AppClientParams))
 
 A client for interacting with an Algorand smart contract application.

docs/markdown/autoapi/algokit_utils/applications/app_deployer/index.md

@@ -13,7 +13,7 @@
 | [`ApplicationMetaData`](#algokit_utils.applications.app_deployer.ApplicationMetaData)       | Complete metadata about a deployed app                                        |
 | [`ApplicationLookup`](#algokit_utils.applications.app_deployer.ApplicationLookup)           | Cache of {py:class}\`ApplicationMetaData\` for a specific creator             |
 | [`AppDeployParams`](#algokit_utils.applications.app_deployer.AppDeployParams)               | Parameters for deploying an app                                               |
-| [`AppDeployResult`](#algokit_utils.applications.app_deployer.AppDeployResult)               |                                                                               |
+| [`AppDeployResult`](#algokit_utils.applications.app_deployer.AppDeployResult)               | The result of a deployment                                                    |
 | [`AppDeployer`](#algokit_utils.applications.app_deployer.AppDeployer)                       | Manages deployment and deployment metadata of applications                    |
 
 ## Module Contents
@@ -85,38 +85,72 @@ Parameters for deploying an app
 
 #### metadata *: [AppDeploymentMetaData](#algokit_utils.applications.app_deployer.AppDeploymentMetaData)*
 
+The deployment metadata
+
 #### deploy_time_params *: algokit_utils.models.state.TealTemplateParams | None* *= None*
 
+Optional template parameters to use during compilation
+
 #### on_schema_break *: Literal['replace', 'fail', 'append'] | [algokit_utils.applications.enums.OnSchemaBreak](../enums/index.md#algokit_utils.applications.enums.OnSchemaBreak) | None* *= None*
 
+Optional on schema break action
+
 #### on_update *: Literal['update', 'replace', 'fail', 'append'] | [algokit_utils.applications.enums.OnUpdate](../enums/index.md#algokit_utils.applications.enums.OnUpdate) | None* *= None*
 
+Optional on update action
+
 #### create_params *: [algokit_utils.transactions.transaction_composer.AppCreateParams](../../transactions/transaction_composer/index.md#algokit_utils.transactions.transaction_composer.AppCreateParams) | [algokit_utils.transactions.transaction_composer.AppCreateMethodCallParams](../../transactions/transaction_composer/index.md#algokit_utils.transactions.transaction_composer.AppCreateMethodCallParams)*
 
+The creation parameters
+
 #### update_params *: [algokit_utils.transactions.transaction_composer.AppUpdateParams](../../transactions/transaction_composer/index.md#algokit_utils.transactions.transaction_composer.AppUpdateParams) | [algokit_utils.transactions.transaction_composer.AppUpdateMethodCallParams](../../transactions/transaction_composer/index.md#algokit_utils.transactions.transaction_composer.AppUpdateMethodCallParams)*
 
+The update parameters
+
 #### delete_params *: [algokit_utils.transactions.transaction_composer.AppDeleteParams](../../transactions/transaction_composer/index.md#algokit_utils.transactions.transaction_composer.AppDeleteParams) | [algokit_utils.transactions.transaction_composer.AppDeleteMethodCallParams](../../transactions/transaction_composer/index.md#algokit_utils.transactions.transaction_composer.AppDeleteMethodCallParams)*
 
+The deletion parameters
+
 #### existing_deployments *: [ApplicationLookup](#algokit_utils.applications.app_deployer.ApplicationLookup) | None* *= None*
 
+Optional existing deployments
+
 #### ignore_cache *: bool* *= False*
 
+Whether to ignore the cache
+
 #### max_fee *: int | None* *= None*
 
+Optional maximum fee
+
 #### send_params *: [algokit_utils.models.transaction.SendParams](../../models/transaction/index.md#algokit_utils.models.transaction.SendParams) | None* *= None*
 
+Optional send parameters
+
 ### *class* algokit_utils.applications.app_deployer.AppDeployResult
 
+The result of a deployment
+
 #### app *: [ApplicationMetaData](#algokit_utils.applications.app_deployer.ApplicationMetaData)*
 
+The application metadata
+
 #### operation_performed *: [algokit_utils.applications.enums.OperationPerformed](../enums/index.md#algokit_utils.applications.enums.OperationPerformed)*
 
+The operation performed
+
 #### create_result *: [algokit_utils.transactions.transaction_sender.SendAppCreateTransactionResult](../../transactions/transaction_sender/index.md#algokit_utils.transactions.transaction_sender.SendAppCreateTransactionResult)[[algokit_utils.applications.abi.ABIReturn](../abi/index.md#algokit_utils.applications.abi.ABIReturn)] | None* *= None*
 
+The create result
+
 #### update_result *: [algokit_utils.transactions.transaction_sender.SendAppUpdateTransactionResult](../../transactions/transaction_sender/index.md#algokit_utils.transactions.transaction_sender.SendAppUpdateTransactionResult)[[algokit_utils.applications.abi.ABIReturn](../abi/index.md#algokit_utils.applications.abi.ABIReturn)] | None* *= None*
 
+The update result
+
 #### delete_result *: [algokit_utils.transactions.transaction_sender.SendAppTransactionResult](../../transactions/transaction_sender/index.md#algokit_utils.transactions.transaction_sender.SendAppTransactionResult)[[algokit_utils.applications.abi.ABIReturn](../abi/index.md#algokit_utils.applications.abi.ABIReturn)] | None* *= None*
 
+The delete result
+
 ### *class* algokit_utils.applications.app_deployer.AppDeployer(app_manager: [algokit_utils.applications.app_manager.AppManager](../app_manager/index.md#algokit_utils.applications.app_manager.AppManager), transaction_sender: [algokit_utils.transactions.transaction_sender.AlgorandClientTransactionSender](../../transactions/transaction_sender/index.md#algokit_utils.transactions.transaction_sender.AlgorandClientTransactionSender), indexer: algosdk.v2client.indexer.IndexerClient | None = None)
 
 Manages deployment and deployment metadata of applications