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: update userguides and notes [APE-1752] #2109

Merged
merged 18 commits into from
Jun 4, 2024

Conversation

dtdang
Copy link
Contributor

@dtdang dtdang commented Jun 3, 2024

What I did

Update broken userguide links for 0.8 update and change notes and warnings to myst directive formatting.

fixes: #

How I did it

How to verify it

Checklist

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

@dtdang dtdang changed the title docs: update userguides and notes docs: update userguides and notes [APE-1752] Jun 3, 2024
Copy link
Member

@antazoey antazoey left a comment

Choose a reason for hiding this comment

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

couple of things i noticed in the docs but looks good!

docs/userguides/contracts.md Outdated Show resolved Hide resolved
docs/userguides/data.md Outdated Show resolved Hide resolved
docs/userguides/dependencies.md Show resolved Hide resolved
docs/userguides/networks.md Show resolved Hide resolved
docs/userguides/transactions.md Outdated Show resolved Hide resolved
antazoey
antazoey previously approved these changes Jun 3, 2024
fubuloubu
fubuloubu previously approved these changes Jun 3, 2024
Copy link
Member

@fubuloubu fubuloubu left a comment

Choose a reason for hiding this comment

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

docs lookin' 🔥

docs/userguides/transactions.md Show resolved Hide resolved
antazoey
antazoey previously approved these changes Jun 4, 2024
@@ -355,6 +355,7 @@ def raises_not_implemented(fn):
def inner(*args, **kwargs):
raise _create_raises_not_implemented_error(fn)

inner.__doc__ = fn.__doc__
Copy link
Member

Choose a reason for hiding this comment

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

it may be worth putting a comment here saying this is needed for the doc strings to show up

@dtdang dtdang enabled auto-merge (squash) June 4, 2024 14:34
@dtdang dtdang merged commit 4b69ce3 into ApeWorX:main Jun 4, 2024
15 checks passed
@dtdang dtdang deleted the docs/update_receipt branch June 4, 2024 15: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.

3 participants