-
-
Notifications
You must be signed in to change notification settings - Fork 400
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
Add examples #446
Labels
API
documentation
update documentation
enhancement
New feature or request
good first issue
Good for newcomers
help wanted
Extra attention is needed
Milestone
Comments
Razican
added
enhancement
New feature or request
help wanted
Extra attention is needed
documentation
update documentation
API
good first issue
Good for newcomers
labels
Jun 2, 2020
@Razican I can help with this. |
Go ahead! Thanks :) |
elasmojs
added a commit
to elasmojs/boa
that referenced
this issue
Aug 14, 2020
Added boa examples as per issue boa-dev#446
@Razican the examples are completed except for point 4, i am not sure if I have figured that out. I will raise a pull request now |
This was referenced Aug 14, 2020
Closed
@Razican should this be on hold until we know what the public API will look like? |
I think so, yes. But the public API is already pretty good, so some examples can be added. |
jasonwilliams
pushed a commit
that referenced
this issue
Mar 7, 2021
Added boa examples as per issue #446
jasonwilliams
pushed a commit
that referenced
this issue
Apr 5, 2021
Added boa examples as per issue #446
Razican
pushed a commit
that referenced
this issue
May 22, 2021
Added boa examples as per issue #446
jasonwilliams
pushed a commit
to jasonwilliams/boa
that referenced
this issue
Nov 2, 2021
Added boa examples as per issue boa-dev#446
jasonwilliams
pushed a commit
that referenced
this issue
Nov 2, 2021
Added boa examples as per issue #446
jasonwilliams
pushed a commit
that referenced
this issue
Dec 15, 2021
Added boa examples as per issue #446
jasonwilliams
pushed a commit
that referenced
this issue
Feb 7, 2022
Added boa examples as per issue #446
jasonwilliams
pushed a commit
that referenced
this issue
Feb 7, 2022
Added boa examples as per issue #446
jasonwilliams
pushed a commit
to jasonwilliams/boa
that referenced
this issue
Mar 3, 2022
Added boa examples as per issue boa-dev#446
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
API
documentation
update documentation
enhancement
New feature or request
good first issue
Good for newcomers
help wanted
Extra attention is needed
Current situation
We currently have no code examples to use the API externally both in the API documentation and in the nonexistent
examples
folder.What do we need?
As mentioned in #445, we should be creating a new API, but in any case, we would need to create examples for some common use cases of Boa. I'm extracting here part of that discussion:
I think we need at least one example of each, that gets tested on each commit, in the
examples
directory of theboa
crate. Then, I would add parts of those examples to the library-level documentation, in order to make life easier for our users.The text was updated successfully, but these errors were encountered: