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.

Sign up for GitHub

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

Jump to bottom

docs: more context on boa usage and examples #181

Merged
merged 21 commits into from
Apr 11, 2024
Merged

docs: more context on boa usage and examples #181

merged 21 commits into from
Apr 11, 2024

Conversation

AlbertoCentonze
Copy link
Contributor

@AlbertoCentonze AlbertoCentonze commented Mar 1, 2024 •
edited
Loading

What I did

Improved documentation

How I did it

Adding the following sections:

  • introduction explaining why the need for this framework + integrate what is already in the readme
  • install instructions (pip, poetry...), how to use the latest version from git.

Minor mentions added

  • native import syntax
  • coverage doesn't work in fast mode
  • fast mode
  • jupyter notebook magic stuff

Structural changes:

  • merge the coverage section in the testing one (the two are short and related).

Description for the changelog

docs: more context on boa usage and examples

Cute Animal Picture

image

charles-cooper
charles-cooper reviewed Mar 2, 2024
View reviewed changes
docs/source/api.rst Outdated Show resolved Hide resolved
charles-cooper
charles-cooper reviewed Mar 9, 2024
View reviewed changes
docs/source/test.rst Outdated Show resolved Hide resolved
@AlbertoCentonze AlbertoCentonze marked this pull request as ready for review March 26, 2024 10:03
@AlbertoCentonze AlbertoCentonze changed the title docs: added intro and install instructions docs: more context on boa usage and examples Mar 26, 2024
charles-cooper
charles-cooper approved these changes Apr 11, 2024
View reviewed changes
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.

thanks!

@charles-cooper charles-cooper merged commit 409d8b1 into vyperlang:master Apr 11, 2024
8 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@charles-cooper charles-cooper charles-cooper approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AlbertoCentonze @charles-cooper