Update example docs with latest ethpm v3 packages #1683
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
njgheorghita
force-pushed
the
update-ethpm-packages-docs
branch
2 times, most recently
from
627da86
to
06594c4
Compare
wolovim
approved these changes
Jul 13, 2020
docs/ethpm.rst
Outdated
| @@ -46,6 +46,9 @@ new ``Package`` class for a given package. | |||
| >>> OwnedPackage = Package.from_file(owned_manifest_path, w3) | |||
| >>> assert isinstance(OwnedPackage, Package) | |||
|
|
|||
| For a closer look at how to interact with EthPM packages using web3, check out the | |||
| `examples page <https://web3py.readthedocs.io/en/stable/examples.html#working-with-contracts-via-ethpm>`__. | |||
There was a problem hiding this comment.
nit: I've been following an existing pattern linking to references instead of full URLs. For example, create an reference (terminology?) above the example with, e.g., .. _ethpm_example:, then here you can link to it like
...check out the :ref:`examples page <ethpm_example>`
This way the link won't break if the name changes or the example moves around.
There was a problem hiding this comment.
Nice, yeah that's a good call. I use that style for same-page references, but wasn't sure about cross-page refs (rst is sooo much fun!). But, I tested it locally and it works just as you typed out, thanks!
njgheorghita
force-pushed
the
update-ethpm-packages-docs
branch
from
06594c4
to
af92cd9
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What was wrong?
examples.rstdocs needed an update to reflect the latest ethpm v3 upgrade.Todo:
Cute Animal Picture