Update documentation

ApeWorX · Sep 17, 2024 · 7472e06 · 7472e06
1 parent f483599
commit 7472e06
Show file tree

Hide file tree

Showing 29 changed files with 90 additions and 83 deletions.
diff --git a/latest/.buildinfo b/latest/.buildinfo
@@ -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: 251bd55a0ad183e8e17e3e225cf1d635
+config: 658ae140c3b24ea04c11869e5fa6ffc7
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/latest/.doctrees/commands/networks.doctree b/latest/.doctrees/commands/networks.doctree
diff --git a/latest/.doctrees/commands/pm.doctree b/latest/.doctrees/commands/pm.doctree
diff --git a/latest/.doctrees/environment.pickle b/latest/.doctrees/environment.pickle
diff --git a/latest/.doctrees/methoddocs/ape.doctree b/latest/.doctrees/methoddocs/ape.doctree
diff --git a/latest/.doctrees/methoddocs/ape_accounts.doctree b/latest/.doctrees/methoddocs/ape_accounts.doctree
diff --git a/latest/.doctrees/methoddocs/ape_compile.doctree b/latest/.doctrees/methoddocs/ape_compile.doctree
diff --git a/latest/.doctrees/methoddocs/ape_ethereum.doctree b/latest/.doctrees/methoddocs/ape_ethereum.doctree
diff --git a/latest/.doctrees/methoddocs/ape_node.doctree b/latest/.doctrees/methoddocs/ape_node.doctree
diff --git a/latest/.doctrees/methoddocs/ape_pm.doctree b/latest/.doctrees/methoddocs/ape_pm.doctree
diff --git a/latest/.doctrees/methoddocs/ape_test.doctree b/latest/.doctrees/methoddocs/ape_test.doctree
diff --git a/latest/.doctrees/methoddocs/api.doctree b/latest/.doctrees/methoddocs/api.doctree
diff --git a/latest/.doctrees/methoddocs/cli.doctree b/latest/.doctrees/methoddocs/cli.doctree
diff --git a/latest/.doctrees/methoddocs/contracts.doctree b/latest/.doctrees/methoddocs/contracts.doctree
diff --git a/latest/.doctrees/methoddocs/exceptions.doctree b/latest/.doctrees/methoddocs/exceptions.doctree
diff --git a/latest/.doctrees/methoddocs/managers.doctree b/latest/.doctrees/methoddocs/managers.doctree
diff --git a/latest/.doctrees/methoddocs/plugins.doctree b/latest/.doctrees/methoddocs/plugins.doctree
diff --git a/latest/.doctrees/methoddocs/types.doctree b/latest/.doctrees/methoddocs/types.doctree
diff --git a/latest/.doctrees/methoddocs/utils.doctree b/latest/.doctrees/methoddocs/utils.doctree
diff --git a/latest/.doctrees/userguides/dependencies.doctree b/latest/.doctrees/userguides/dependencies.doctree
diff --git a/latest/_sources/userguides/dependencies.md.txt b/latest/_sources/userguides/dependencies.md.txt
@@ -179,12 +179,16 @@ project.dependencies.install(
 
 ### uninstall
 
-Remove previously installed packages using the `uninstall` command:
+Remove previously installed packages using the `uninstall` command, providing it either the dependency's name or package_id:
 
 ```shell
 ape pm uninstall OpenZeppelin
 ```
 
+```shell
+ape pm uninstall OpenZeppelin/openzeppelin-contracts
+```
+
 If there is a single version installed, the command will remove the single version.
 If multiple versions are installed, pass additional arguments specifying the version(s) to be removed:
 

diff --git a/latest/commands/networks.html b/latest/commands/networks.html
@@ -297,7 +297,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>sepolia | holesky | local | mainnet-fork | sepolia-fork | holesky-fork | mainnet</p>
+<dd class="field-odd"><p>sepolia-fork | sepolia | holesky | mainnet | holesky-fork | mainnet-fork | local</p>
 </dd>
 </dl>
 </dd></dl>
@@ -308,7 +308,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>test | node</p>
+<dd class="field-odd"><p>node | test</p>
 </dd>
 </dl>
 </dd></dl>

diff --git a/latest/commands/pm.html b/latest/commands/pm.html
@@ -378,9 +378,9 @@ <h2>uninstall<a class="headerlink" href="#pm-uninstall" title="Permalink to this
 versions to remove. You can also choose to remove all versions of the package.</p>
 <p>Examples:</p>
 <ul class="simple">
-<li><p>Remove specific versions: ape pm remove &lt;PackageName&gt; “1.0.0” “2.0.0”</p></li>
-<li><p>Prompt to choose versions: ape pm remove &lt;PackageName&gt;</p></li>
-<li><p>Remove all versions: ape pm remove &lt;PackageName&gt; -y</p></li>
+<li><p>Remove specific versions: ape pm uninstall &lt;PackageName&gt; “1.0.0” “2.0.0”</p></li>
+<li><p>Prompt to choose versions: ape pm uninstall &lt;PackageName&gt;</p></li>
+<li><p>Remove all versions: ape pm uninstall &lt;PackageName&gt; -y</p></li>
 </ul>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>pm<span class="w"> </span>uninstall<span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w"> </span><span class="o">[</span>NAME<span class="o">]</span><span class="w"> </span><span class="o">[</span>VERSIONS<span class="o">]</span>...
 </pre></div>

diff --git a/latest/methoddocs/ape_node.html b/latest/methoddocs/ape_node.html
diff --git a/latest/methoddocs/api.html b/latest/methoddocs/api.html
diff --git a/latest/methoddocs/contracts.html b/latest/methoddocs/contracts.html
diff --git a/latest/methoddocs/managers.html b/latest/methoddocs/managers.html
diff --git a/latest/searchindex.js b/latest/searchindex.js
diff --git a/latest/userguides/dependencies.html b/latest/userguides/dependencies.html
@@ -426,10 +426,13 @@ <h3>install<a class="headerlink" href="#install" title="Permalink to this headin
 </section>
 <section id="uninstall">
 <h3>uninstall<a class="headerlink" href="#uninstall" title="Permalink to this heading"></a></h3>
-<p>Remove previously installed packages using the <code class="docutils literal notranslate"><span class="pre">uninstall</span></code> command:</p>
+<p>Remove previously installed packages using the <code class="docutils literal notranslate"><span class="pre">uninstall</span></code> command, providing it either the dependency’s name or package_id:</p>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>ape<span class="w"> </span>pm<span class="w"> </span>uninstall<span class="w"> </span>OpenZeppelin
 </pre></div>
 </div>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>ape<span class="w"> </span>pm<span class="w"> </span>uninstall<span class="w"> </span>OpenZeppelin/openzeppelin-contracts
+</pre></div>
+</div>
 <p>If there is a single version installed, the command will remove the single version.
 If multiple versions are installed, pass additional arguments specifying the version(s) to be removed:</p>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>ape<span class="w"> </span>pm<span class="w"> </span>uninstall<span class="w"> </span>OpenZeppelin<span class="w"> </span><span class="m">4</span>.5.0<span class="w"> </span><span class="m">4</span>.6.0