Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Feb 9, 2024
1 parent 48c2d2e commit 2d958dd
Show file tree
Hide file tree
Showing 21 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion latest/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 6e924a42805053a25e4d26e0e4b8f115
config: d18bfbd82fda2a7235d702548901d4b8
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file modified latest/.doctrees/commands/networks.doctree
Binary file not shown.
Binary file modified latest/.doctrees/environment.pickle
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/ape_accounts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/api.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/cli.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/contracts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/exceptions.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/managers.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/plugins.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/types.doctree
Binary file not shown.
Binary file modified latest/.doctrees/methoddocs/utils.doctree
Binary file not shown.
Binary file modified latest/.doctrees/userguides/contracts.doctree
Binary file not shown.
Binary file modified latest/.doctrees/userguides/scripts.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion latest/_sources/userguides/contracts.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ To avoid naming collisions with other properties on the `project` object, you ca
```python
from ape import project

contract = property.get_contract("MyContract") # Same as `project.MyContract`.
contract = project.get_contract("MyContract") # Same as `project.MyContract`.
```

Notice when deploying, we have to specify the `sender=` kwarg because `deploy` operations are transactions.
Expand Down
2 changes: 1 addition & 1 deletion latest/_sources/userguides/scripts.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ from ape.cli import ConnectedProviderCommand

@click.command(cls=ConnectedProviderCommand)
def cli(ecosystem, network):
click(f"You selected a provider on ecosystem '{ecosystem.name}' and {network.name}.")
click.echo(f"You selected a provider on ecosystem '{ecosystem.name}' and {network.name}.")

@click.command(cls=ConnectedProviderCommand)
def cli(network, provider):
Expand Down
4 changes: 2 additions & 2 deletions latest/commands/networks.html
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Permalink to this hea
<dd><p>Filter the results by network</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>goerli-fork | goerli | mainnet-fork | mainnet | sepolia | local | sepolia-fork</p>
<dd class="field-odd"><p>mainnet-fork | sepolia-fork | goerli-fork | goerli | local | mainnet | sepolia</p>
</dd>
</dl>
</dd></dl>
Expand All @@ -267,7 +267,7 @@ <h2>list<a class="headerlink" href="#networks-list" title="Permalink to this hea
<dd><p>Filter the results by provider</p>
<dl class="field-list simple">
<dt class="field-odd">Options<span class="colon">:</span></dt>
<dd class="field-odd"><p>geth | test</p>
<dd class="field-odd"><p>test | geth</p>
</dd>
</dl>
</dd></dl>
Expand Down
2 changes: 1 addition & 1 deletion latest/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion latest/userguides/contracts.html
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ <h2>From Deploy<a class="headerlink" href="#from-deploy" title="Permalink to thi
To avoid naming collisions with other properties on the <code class="docutils literal notranslate"><span class="pre">project</span></code> object, you can alternatively use the <a class="reference external" href="../methoddocs/managers.html#ape.managers.project.manager.ProjectManager.get_contract">get_contract()</a> method to retrieve contract containers.</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">ape</span> <span class="kn">import</span> <span class="n">project</span>

<span class="n">contract</span> <span class="o">=</span> <span class="nb">property</span><span class="o">.</span><span class="n">get_contract</span><span class="p">(</span><span class="s2">&quot;MyContract&quot;</span><span class="p">)</span> <span class="c1"># Same as `project.MyContract`.</span>
<span class="n">contract</span> <span class="o">=</span> <span class="n">project</span><span class="o">.</span><span class="n">get_contract</span><span class="p">(</span><span class="s2">&quot;MyContract&quot;</span><span class="p">)</span> <span class="c1"># Same as `project.MyContract`.</span>
</pre></div>
</div>
<p>Notice when deploying, we have to specify the <code class="docutils literal notranslate"><span class="pre">sender=</span></code> kwarg because <code class="docutils literal notranslate"><span class="pre">deploy</span></code> operations are transactions.
Expand Down
2 changes: 1 addition & 1 deletion latest/userguides/scripts.html
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ <h2>CLI Scripts<a class="headerlink" href="#cli-scripts" title="Permalink to thi

<span class="nd">@click</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="bp">cls</span><span class="o">=</span><span class="n">ConnectedProviderCommand</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">cli</span><span class="p">(</span><span class="n">ecosystem</span><span class="p">,</span> <span class="n">network</span><span class="p">):</span>
<span class="n">click</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;You selected a provider on ecosystem &#39;</span><span class="si">{</span><span class="n">ecosystem</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39; and </span><span class="si">{</span><span class="n">network</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span>
<span class="n">click</span><span class="o">.</span><span class="n">echo</span><span class="p">(</span><span class="sa">f</span><span class="s2">&quot;You selected a provider on ecosystem &#39;</span><span class="si">{</span><span class="n">ecosystem</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">&#39; and </span><span class="si">{</span><span class="n">network</span><span class="o">.</span><span class="n">name</span><span class="si">}</span><span class="s2">.&quot;</span><span class="p">)</span>

<span class="nd">@click</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="bp">cls</span><span class="o">=</span><span class="n">ConnectedProviderCommand</span><span class="p">)</span>
<span class="k">def</span> <span class="nf">cli</span><span class="p">(</span><span class="n">network</span><span class="p">,</span> <span class="n">provider</span><span class="p">):</span>
Expand Down

0 comments on commit 2d958dd

Please sign in to comment.