-
-
Notifications
You must be signed in to change notification settings - Fork 928
chore: fix JavaScript lint errors (issue #8282) #8293
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
chore: fix JavaScript lint errors (issue #8282) #8293
Conversation
|
Hello! Thank you for your contribution to stdlib. We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:
This acknowledgment confirms that you've read the guidelines, which include:
We can't review or accept contributions without this acknowledgment. Thank you for your understanding and cooperation. We look forward to reviewing your contribution! |
|
👋 Hi there! 👋 And thank you for opening your first pull request! We will review it shortly. 🏃 💨 Getting Started
Next Steps
Running Tests LocallyYou can use # Run tests for all packages in the math namespace:
make test TESTS_FILTER=".*/@stdlib/math/.*"
# Run benchmarks for a specific package:
make benchmark BENCHMARKS_FILTER=".*/@stdlib/math/base/special/sin/.*"If you haven't heard back from us within two weeks, please ping us by tagging the "reviewers" team in a comment on this PR. If you have any further questions while waiting for a response, please join our Gitter channel to chat with project maintainers and other community members. We appreciate your contribution! Documentation Links |
Coverage Report
The above coverage report was generated for the changes in this PR. |
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. The actual lint error stems from instances originating from different realms. This should now be addressed.
|
As the CI failure does not stem from changes introduced in this PR, I'll go ahead and merge. |
|
Thank you for your contribution and congratulations on your first PR! |
Resolves #8282
Description
This pull request fixes a JavaScript doctest linting failure detected by CI. An example returned a Buffer in some environments while the doctest expected a string. The example has been updated so the sync read uses an options object with an explicit encoding, ensuring the example deterministically returns a string and the inline doctest matches the actual output.
Change summary:
lib/node_modules/@stdlib/fs/read-file/examples/index.jsto call:readFile.sync(__filename, { 'encoding': 'utf8' })so the example prints a string and the doctest expectation is correct.
How I verified:
Related Issues
Checklist
@stdlib-js/reviewers