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

added ape to testing of vyper #3366

Closed
wants to merge 1 commit into from

Conversation

PatrickAlphaC
Copy link

What I did

Added Ape to Vyper docs

How I did it

Copy-pasted the ape markdown on testing into a vyper doc.

Description for the changelog

Cute Animal Picture

Put a link to a cute animal picture inside the parenthesis-->

@codecov-commenter
Copy link

codecov-commenter commented Apr 21, 2023

Codecov Report

Merging #3366 (4e4645f) into master (c93bc06) will not change coverage.
The diff coverage is n/a.

📣 This organization is not using Codecov’s GitHub App Integration. We recommend you install it so Codecov can continue to function properly for your repositories. Learn more

@@           Coverage Diff           @@
##           master    #3366   +/-   ##
=======================================
  Coverage   88.96%   88.96%           
=======================================
  Files          84       84           
  Lines       10600    10600           
  Branches     2211     2211           
=======================================
  Hits         9430     9430           
  Misses        766      766           
  Partials      404      404           

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@@ -5,6 +5,7 @@ Testing a Contract

For testing Vyper contracts we recommend the use of `pytest <https://docs.pytest.org/en/latest/contents.html>`_ along with one of the following packages:

* `Ape <https://github.com/ApeWorX/ape>`_: A development and testing framework for smart contracts targeting the Ethereum Virtual Machine
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
* `Ape <https://github.com/ApeWorX/ape>`_: A development and testing framework for smart contracts targeting the Ethereum Virtual Machine
* `Ape <https://github.com/ApeWorX/ape>`_: The smart contract development tool for Pythonistas, Data Scientists, and Security Professionals

Copy link
Member

Choose a reason for hiding this comment

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

Also curious if it might be better to link to our docs directly instead of creating separate copy that has to be kept up to date

https://docs.apeworx.io/ape/stable/userguides/testing.html

Copy link
Author

Choose a reason for hiding this comment

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

+1 ^


```{note}
Ape has built-in test and fixture isolation for all pytest scopes.
To disable isolation add the `--disable-isolation` flag when running `ape test`
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
To disable isolation add the `--disable-isolation` flag when running `ape test`

Copy link
Member

@charles-cooper charles-cooper left a comment

Choose a reason for hiding this comment

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

i think this PR would be better as a link to ape docs.

@fubuloubu
Copy link
Member

i think this PR would be better as a link to ape docs.

referenced here: ApeWorX/ape-vyper#101

@fubuloubu fubuloubu closed this Nov 7, 2023
@fubuloubu
Copy link
Member

may be worth created another issue removing the brownie docs from here

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.

4 participants