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 README.md and add boa_cli's README.md #3659

Merged
merged 2 commits into from
Feb 7, 2024
Merged

Conversation

nekevss
Copy link
Member

@nekevss nekevss commented Feb 5, 2024

Another small doc update with edits to README.md and creates a README.md for boa_cli

Changes are:

  • Adds a README.md to boa_cli
  • Adds boa_cli to list of published crates in the README.md
  • Wraps the example in a main() for consistency.
  • Stacks the documentation links

I was going to try and make some gifs with vhs, but apparently it's bugged on Windows and WSL wasn't working either (Yet another just Windows issue 😭). Granted it could also be a good first issue for someone.

@nekevss nekevss added the documentation update documentation label Feb 5, 2024
@nekevss nekevss added this to the v0.18.0 milestone Feb 5, 2024
@nekevss nekevss requested a review from a team February 5, 2024 23:55
Copy link

github-actions bot commented Feb 6, 2024

Test262 conformance changes

Test result main count PR count difference
Total 96,422 96,422 0
Passed 80,991 80,991 0
Ignored 3,567 3,567 0
Failed 11,864 11,864 0
Panics 0 0 0
Conformance 84.00% 84.00% 0.00%

@nekevss nekevss added the waiting-on-review Waiting on reviews from the maintainers label Feb 6, 2024
Copy link
Member

@HalidOdat HalidOdat left a comment

Choose a reason for hiding this comment

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

Looks good! Just a nitpick! :)

I was going to try and make some gifs with vhs, but apparently it's bugged on Windows and WSL wasn't working either (Yet another just Windows issue 😭).

I've been there before... Time for you to step into the light and embrace Linux! 😆

README.md Outdated
Ok(res) => {
println!(
"{}",
res.to_string(&mut context).unwrap().to_std_string_escaped()
Copy link
Member

Choose a reason for hiding this comment

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

Since it's wrapped in a function, I Would prefer using the ? error propagation and making main return a JsResult.

If not then using a display method that does not return a result res.display() we can also remove the .to_std_string_escaped() since it implements Display

@nekevss nekevss requested a review from a team February 7, 2024 00:11
@jedel1043 jedel1043 added this pull request to the merge queue Feb 7, 2024
Merged via the queue into main with commit 9804c77 Feb 7, 2024
13 checks passed
@nekevss nekevss deleted the cli-docs-update branch February 9, 2024 13:54
@jedel1043 jedel1043 removed the waiting-on-review Waiting on reviews from the maintainers label Sep 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation update documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants