Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: wrap up link fixes [APE-1482] #1711

Merged
merged 6 commits into from
Oct 31, 2023
Merged

Conversation

antazoey
Copy link
Member

What I did

The real issue was fixed by #1321
but it was never closed
This completes it by auditing and "fixing" the rest: fixes: #1263

I could find no more bad links after this

How I did it

How to verify it

Checklist

  • All changes are completed
  • New test cases have been added
  • Documentation has been updated

@vany365 vany365 changed the title docs: fixes docs: fixes [APE-1482] Oct 31, 2023
@antazoey antazoey changed the title docs: fixes [APE-1482] docs: wrap up link fixes [APE-1482] Oct 31, 2023
@@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is no longer a real link it seems

@@ -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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these were just missed opportunities for links


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.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this part was just wordy and distracting, so i tidied it up

fubuloubu
fubuloubu previously approved these changes Oct 31, 2023
@@ -7,6 +7,11 @@

from ape.types import AddressType

# Fix 404 in doc link.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is maybe the 404 the original ticket was talking about?
Before, we just got the doc from the package it is from (in the EF), but its links didnt work when in ape's docs

This fixes it!

fubuloubu
fubuloubu previously approved these changes Oct 31, 2023
src/ape/api/accounts.py Outdated Show resolved Hide resolved
@antazoey antazoey merged commit be57c14 into ApeWorX:main Oct 31, 2023
15 checks passed
@antazoey antazoey deleted the docs/link-fixes branch October 31, 2023 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix docs that link to 2nd and 3rd party packages
2 participants