Skip to content

Commit

Permalink
docs: apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Neil Campbell <neil.campbell@makerx.com.au>
  • Loading branch information
aorumbayev and neilcampbell committed Feb 19, 2025
1 parent 8b3af0f commit 0d3a455
Show file tree
Hide file tree
Showing 9 changed files with 17 additions and 17 deletions.
6 changes: 3 additions & 3 deletions docs/html/_sources/capabilities/app-deploy.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ An example of the ARC-2 transaction note that is attached as an app creation / u
ALGOKIT_DEPLOYER:j{name:"MyApp",version:"1.0",updatable:true,deletable:false}
```

> NOTE: Starting from v3.0.0, AlgoKit Utils no longer automatically increments the contract version by default. It is end user's responsibility to explicitly manage versioning of their smart contracts (if desired).
> NOTE: Starting from v3.0.0, AlgoKit Utils no longer automatically increments the contract version by default. It is the user's responsibility to explicitly manage versioning of their smart contracts (if desired).

## Lookup deployed apps by name

Expand Down Expand Up @@ -201,11 +201,11 @@ Below is a sample in [Algorand Python SDK](https://github.com/algorandfoundation
# ... your contract code ...
@arc4.baremethod(allow_actions=["UpdateApplication"])
def update(self) -> None:
assert TemplateVar[bool](UPDATABLE_TEMPLATE_NAME)
assert TemplateVar[bool]("UPDATABLE")

@arc4.baremethod(allow_actions=["DeleteApplication"])
def delete(self) -> None:
assert TemplateVar[bool](DELETABLE_TEMPLATE_NAME)
assert TemplateVar[bool]("DELETABLE")
# ... your contract code ...
```

Expand Down
2 changes: 1 addition & 1 deletion docs/html/_sources/v3-migration-guide.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ result = algorand.send.asset_opt_in(
4. **Application Client**

- Split into `AppClient`, `AppDeployer` and `AppFactory`
- `deploy` method in `AppFactory`/`AppDeployer` no longer auto increments the contract version by default. It is end user's responsibility to explicitly manage versioning of their smart contracts (if desired).
- `deploy` method in `AppFactory`/`AppDeployer` no longer auto increments the contract version by default. It is the user's responsibility to explicitly manage versioning of their smart contracts (if desired).
- New intuitive structured interface for creating or sending `AppCall`|`AppMethodCall` transactions
- ARC-56 support along with automatic conversion of specs from ARC-32 to ARC-56

Expand Down
6 changes: 3 additions & 3 deletions docs/html/capabilities/app-deploy.html
Original file line number Diff line number Diff line change
Expand Up @@ -386,7 +386,7 @@ <h2>Deployment metadata<a class="headerlink" href="#deployment-metadata" title="
</pre></div>
</div>
<blockquote>
<div><p>NOTE: Starting from v3.0.0, AlgoKit Utils no longer automatically increments the contract version by default. It is end user’s responsibility to explicitly manage versioning of their smart contracts (if desired).</p>
<div><p>NOTE: Starting from v3.0.0, AlgoKit Utils no longer automatically increments the contract version by default. It is the user’s responsibility to explicitly manage versioning of their smart contracts (if desired).</p>
</div></blockquote>
</section>
<section id="lookup-deployed-apps-by-name">
Expand Down Expand Up @@ -512,11 +512,11 @@ <h4>Making updatable/deletable apps<a class="headerlink" href="#making-updatable
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="c1"># ... your contract code ...</span>
<span class="nd">@arc4</span><span class="o">.</span><span class="n">baremethod</span><span class="p">(</span><span class="n">allow_actions</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;UpdateApplication&quot;</span><span class="p">])</span>
<span class="k">def</span><span class="w"> </span><span class="nf">update</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">assert</span> <span class="n">TemplateVar</span><span class="p">[</span><span class="nb">bool</span><span class="p">](</span><span class="n">UPDATABLE_TEMPLATE_NAME</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">TemplateVar</span><span class="p">[</span><span class="nb">bool</span><span class="p">](</span><span class="s2">&quot;UPDATABLE&quot;</span><span class="p">)</span>

<span class="nd">@arc4</span><span class="o">.</span><span class="n">baremethod</span><span class="p">(</span><span class="n">allow_actions</span><span class="o">=</span><span class="p">[</span><span class="s2">&quot;DeleteApplication&quot;</span><span class="p">])</span>
<span class="k">def</span><span class="w"> </span><span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">assert</span> <span class="n">TemplateVar</span><span class="p">[</span><span class="nb">bool</span><span class="p">](</span><span class="n">DELETABLE_TEMPLATE_NAME</span><span class="p">)</span>
<span class="k">assert</span> <span class="n">TemplateVar</span><span class="p">[</span><span class="nb">bool</span><span class="p">](</span><span class="s2">&quot;DELETABLE&quot;</span><span class="p">)</span>
<span class="c1"># ... your contract code ...</span>
</pre></div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion docs/html/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/html/v3-migration-guide.html
Original file line number Diff line number Diff line change
Expand Up @@ -577,7 +577,7 @@ <h2>Breaking Changes<a class="headerlink" href="#breaking-changes" title="Link t
<li><p><strong>Application Client</strong></p>
<ul class="simple">
<li><p>Split into <code class="docutils literal notranslate"><span class="pre">AppClient</span></code>, <code class="docutils literal notranslate"><span class="pre">AppDeployer</span></code> and <code class="docutils literal notranslate"><span class="pre">AppFactory</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">deploy</span></code> method in <code class="docutils literal notranslate"><span class="pre">AppFactory</span></code>/<code class="docutils literal notranslate"><span class="pre">AppDeployer</span></code> no longer auto increments the contract version by default. It is end user’s responsibility to explicitly manage versioning of their smart contracts (if desired).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">deploy</span></code> method in <code class="docutils literal notranslate"><span class="pre">AppFactory</span></code>/<code class="docutils literal notranslate"><span class="pre">AppDeployer</span></code> no longer auto increments the contract version by default. It is the user’s responsibility to explicitly manage versioning of their smart contracts (if desired).</p></li>
<li><p>New intuitive structured interface for creating or sending <code class="docutils literal notranslate"><span class="pre">AppCall</span></code>|<code class="docutils literal notranslate"><span class="pre">AppMethodCall</span></code> transactions</p></li>
<li><p>ARC-56 support along with automatic conversion of specs from ARC-32 to ARC-56</p></li>
</ul>
Expand Down
6 changes: 3 additions & 3 deletions docs/markdown/capabilities/app-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ An example of the ARC-2 transaction note that is attached as an app creation / u
ALGOKIT_DEPLOYER:j{name:"MyApp",version:"1.0",updatable:true,deletable:false}
```

> NOTE: Starting from v3.0.0, AlgoKit Utils no longer automatically increments the contract version by default. It is end user’s responsibility to explicitly manage versioning of their smart contracts (if desired).
> NOTE: Starting from v3.0.0, AlgoKit Utils no longer automatically increments the contract version by default. It is the user’s responsibility to explicitly manage versioning of their smart contracts (if desired).
## Lookup deployed apps by name

Expand Down Expand Up @@ -201,11 +201,11 @@ Below is a sample in [Algorand Python SDK](https://github.com/algorandfoundation
# ... your contract code ...
@arc4.baremethod(allow_actions=["UpdateApplication"])
def update(self) -> None:
assert TemplateVar[bool](UPDATABLE_TEMPLATE_NAME)
assert TemplateVar[bool]("UPDATABLE")

@arc4.baremethod(allow_actions=["DeleteApplication"])
def delete(self) -> None:
assert TemplateVar[bool](DELETABLE_TEMPLATE_NAME)
assert TemplateVar[bool]("DELETABLE")
# ... your contract code ...
```

Expand Down
2 changes: 1 addition & 1 deletion docs/markdown/v3-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ result = algorand.send.asset_opt_in(
- Removing necessity to interact with low level and untyped `algosdk` abstractions for assembling, signing and sending transaction(s).
4. **Application Client**
- Split into `AppClient`, `AppDeployer` and `AppFactory`
- `deploy` method in `AppFactory`/`AppDeployer` no longer auto increments the contract version by default. It is end user’s responsibility to explicitly manage versioning of their smart contracts (if desired).
- `deploy` method in `AppFactory`/`AppDeployer` no longer auto increments the contract version by default. It is the user’s responsibility to explicitly manage versioning of their smart contracts (if desired).
- New intuitive structured interface for creating or sending `AppCall`|`AppMethodCall` transactions
- ARC-56 support along with automatic conversion of specs from ARC-32 to ARC-56
5. **State Management**
Expand Down
6 changes: 3 additions & 3 deletions docs/source/capabilities/app-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ An example of the ARC-2 transaction note that is attached as an app creation / u
ALGOKIT_DEPLOYER:j{name:"MyApp",version:"1.0",updatable:true,deletable:false}
```

> NOTE: Starting from v3.0.0, AlgoKit Utils no longer automatically increments the contract version by default. It is end user's responsibility to explicitly manage versioning of their smart contracts (if desired).
> NOTE: Starting from v3.0.0, AlgoKit Utils no longer automatically increments the contract version by default. It is the user's responsibility to explicitly manage versioning of their smart contracts (if desired).
## Lookup deployed apps by name

Expand Down Expand Up @@ -201,11 +201,11 @@ Below is a sample in [Algorand Python SDK](https://github.com/algorandfoundation
# ... your contract code ...
@arc4.baremethod(allow_actions=["UpdateApplication"])
def update(self) -> None:
assert TemplateVar[bool](UPDATABLE_TEMPLATE_NAME)
assert TemplateVar[bool]("UPDATABLE")

@arc4.baremethod(allow_actions=["DeleteApplication"])
def delete(self) -> None:
assert TemplateVar[bool](DELETABLE_TEMPLATE_NAME)
assert TemplateVar[bool]("DELETABLE")
# ... your contract code ...
```

Expand Down
2 changes: 1 addition & 1 deletion docs/source/v3-migration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ result = algorand.send.asset_opt_in(
4. **Application Client**

- Split into `AppClient`, `AppDeployer` and `AppFactory`
- `deploy` method in `AppFactory`/`AppDeployer` no longer auto increments the contract version by default. It is end user's responsibility to explicitly manage versioning of their smart contracts (if desired).
- `deploy` method in `AppFactory`/`AppDeployer` no longer auto increments the contract version by default. It is the user's responsibility to explicitly manage versioning of their smart contracts (if desired).
- New intuitive structured interface for creating or sending `AppCall`|`AppMethodCall` transactions
- ARC-56 support along with automatic conversion of specs from ARC-32 to ARC-56

Expand Down

0 comments on commit 0d3a455

Please sign in to comment.