From a5734c50abc3d10e73f999f388bf4a8921da00f2 Mon Sep 17 00:00:00 2001 From: dtdang Date: Fri, 12 Aug 2022 12:12:47 -0700 Subject: [PATCH] docs: doc strings update --- .github/workflows/docs.yaml | 3 ++- ape_alchemy/providers.py | 4 ++-- docs/index.md | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml index 205a2c5..df4b61a 100644 --- a/.github/workflows/docs.yaml +++ b/.github/workflows/docs.yaml @@ -53,4 +53,5 @@ jobs: with: branch: gh-pages directory: gh-pages - github_token: ${{ secrets.GITHUB_TOKEN }} \ No newline at end of file + github_token: ${{ secrets.GITHUB_TOKEN }} + \ No newline at end of file diff --git a/ape_alchemy/providers.py b/ape_alchemy/providers.py index 4bd5c5b..d98fece 100644 --- a/ape_alchemy/providers.py +++ b/ape_alchemy/providers.py @@ -33,7 +33,7 @@ class AlchemyFeatureNotAvailable(AlchemyProviderError): class MissingProjectKeyError(AlchemyProviderError): """ - An error raised when not using one of the options available. + An error raised when there is no API key set. """ def __init__(self, options: Tuple[str, ...]): @@ -53,7 +53,7 @@ class AlchemyEthereumProvider(Web3Provider, UpstreamProvider): @property def uri(self): """ - Build from `ecosystem` and `network`. + Your Alchemy RPC URI, including the project ID. `ecosystem`: choose from supported ecosystems `network`: choose a network to connect to diff --git a/docs/index.md b/docs/index.md index 5cb1aea..b5fc41b 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,4 +1,4 @@ -# Ape-Docs +# Ape-Alchemy Documentation ```{eval-rst} .. toctree::