diff --git a/README.md b/README.md index 6572c47636..c7362a4de5 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ The CLI tool contains all the Ape commands and the Python SDK contains the class ## **Ape Modular Plugin System:** -Our [list of plugins](https://www.apeworx.io/#plugins) is the best way to have the most interoperable experience with Web3. +Our modular plugin system is the best way to have the most interoperable experience with Web3. **NOTE**: If a plugin does not originate from the [ApeWorX GitHub Organization](https://github.com/ApeWorX?q=ape&type=all), you will get a warning about installing 3rd-party plugins. diff --git a/docs/userguides/clis.md b/docs/userguides/clis.md index aac6b7b9de..d3c6d3fe3e 100644 --- a/docs/userguides/clis.md +++ b/docs/userguides/clis.md @@ -18,7 +18,7 @@ This guide is for showcasing utilities that ship with Ape to assist in your CLI ## Ape Context Decorator -The `@ape_cli_context` gives you access to all the root Ape objects (`accounts`, `networks` etc.), the ape logger, and an `abort` method for stopping execution of your CLI gracefully. +The [@ape_cli_context](../methoddocs/cli.html#ape.cli.options.ape_cli_context) gives you access to all the root Ape objects (`accounts`, `networks` etc.), the ape logger, and an [abort](../methoddocs/cli.html#ape.cli.options.ApeCliContextObject.abort) method for stopping execution of your CLI gracefully. Here is an example using all of those features from the `cli_ctx`: ```python @@ -36,8 +36,8 @@ def cmd(cli_ctx): ## Network Tools -The `@network_option()` allows you to select an ecosystem / network / provider combination. -When using with the `NetworkBoundCommand` cls, you can cause your CLI to connect before any of your code executes. +The [@network_option()](../methoddocs/cli.html#ape.cli.options.network_option) allows you to select an ecosystem / network / provider combination. +When using with the [NetworkBoundCommand](../methoddocs/cli.html#ape.cli.commands.NetworkBoundCommand) class, you can cause your CLI to connect before any of your code executes. This is useful if your script or command requires a provider connection in order for it to run. ```python @@ -62,7 +62,7 @@ def cmd(network): ## Account Tools -Use the `@account_option()` for adding an option to your CLIs to select an account. +Use the [@account_option()](../methoddocs/cli.html#ape.cli.options.account_option) for adding an option to your CLIs to select an account. This option does several things: 1. If you only have a single account in Ape (from both test accounts _and_ other accounts), it will use that account as the default. @@ -96,7 +96,7 @@ And when invoking the command from the CLI, it would look like the following: cmd --account TEST::0 # Use the test account at index 0. ``` -Alternatively, you can call the `get_user_selected_account()` directly to have more control of when the account gets selected: +Alternatively, you can call the [get_user_selected_account()](../methoddocs/cli.html#ape.cli.choices.get_user_selected_account) directly to have more control of when the account gets selected: ```python import click @@ -110,8 +110,8 @@ def cmd(): ``` Similarly, there are a couple custom arguments for aliases alone that are useful when making CLIs for account creation. -If you use `@existing_alias_argument()` and specify an alias does not already exist, it will error. -And visa-versa when using `@non_existing_alias_argument()` +If you use [@existing_alias_argument()](../methoddocs/cli.html#ape.cli.arguments.existing_alias_argument) and specify an alias does not already exist, it will error. +And visa-versa when using [@non_existing_alias_argument()](../methoddocs/cli.html#ape.cli.arguments.non_existing_alias_argument). ```python import click diff --git a/docs/userguides/testing.md b/docs/userguides/testing.md index 7031645262..b20f0ce79b 100644 --- a/docs/userguides/testing.md +++ b/docs/userguides/testing.md @@ -47,17 +47,12 @@ To disable isolation add the `--disable-isolation` flag when running `ape test` ## Fixtures -Fixtures are any type of reusable instances of something with configurable scopes. `pytest` handles passing fixtures -into each test method as test-time. To learn more about [fixtures](https://docs.pytest.org/en/7.1.x/explanation/fixtures.html) +You can define and use `pytest` fixtures in your Ape tests. +Learn more about fixtures from [this guide](https://docs.pytest.org/en/7.1.x/explanation/fixtures.html). +The syntax and functionalities of fixtures work exactly the same in Ape as it does with `pytest`. -Define fixtures for static data used by tests. This data can be accessed by all tests in the suite unless specified otherwise. This could be data as well as helpers of modules which will be passed to all tests. - -A common place to define fixtures are in the **conftest.py** which should be saved under the test directory: - -conftest.py is used to import external plugins or modules. By defining the following global variable, pytest will load the module and make it available for its test. - -You can define your own fixtures or use existing ones. The `ape-test` plugin comes -with fixtures you will likely want to use: +The `ape-test` plugin comes with fixtures you will likely want to use. +The following guide explains each fixture that comes with Ape. ### accounts fixture