Skip to content

Conversation

@WillyEverGreen
Copy link
Contributor

@WillyEverGreen WillyEverGreen commented Oct 25, 2025

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:

  • Updated lib/node_modules/@stdlib/fs/read-file/examples/index.js to call:
    • readFile.sync(__filename, { 'encoding': 'utf8' })
      so the example prints a string and the doctest expectation is correct.

How I verified:

  • Ran the example locally and confirmed the output matches the doctest comments.

Related Issues

Checklist

@stdlib-js/reviewers

@stdlib-bot stdlib-bot added the First-time Contributor A pull request from a contributor who has never previously committed to the project repository. label Oct 25, 2025
@stdlib-bot
Copy link
Contributor

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:

  1. Please read our contributing guidelines.

  2. Update your pull request description to include this checked box:

    - [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

  • The developer's certificate of origin
  • Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Oct 25, 2025
@stdlib-bot
Copy link
Contributor

👋 Hi there! 👋

And thank you for opening your first pull request! We will review it shortly. 🏃 💨

Getting Started

Next Steps

  1. A project maintainer will approve GitHub Actions workflows for your PR.
  2. All CI checks must pass before your submission can be fully reviewed.
  3. You'll need to address any failures in linting or unit tests.

Running Tests Locally

You can use make to run any of the CI commands locally from the root directory of the stdlib repository:

# 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

@stdlib-bot
Copy link
Contributor

stdlib-bot commented Oct 25, 2025

Coverage Report

Package Statements Branches Functions Lines
fs/read-file $\color{green}181/181$
$color{green}+100.00%$
$\color{green}10/10$
$color{green}+100.00%$
$\color{green}2/2$
$color{green}+100.00%$
$\color{green}181/181$
$color{green}+100.00%$

The above coverage report was generated for the changes in this PR.

@stdlib-bot stdlib-bot added Good First PR A pull request resolving a Good First Issue. Potential Duplicate There might be another pull request resolving the same issue. labels Oct 26, 2025
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Copy link
Member

@kgryte kgryte left a 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.

@kgryte kgryte removed Needs Review A pull request which needs code review. Potential Duplicate There might be another pull request resolving the same issue. labels Oct 30, 2025
@kgryte
Copy link
Member

kgryte commented Oct 30, 2025

As the CI failure does not stem from changes introduced in this PR, I'll go ahead and merge.

@kgryte kgryte merged commit dfb6f91 into stdlib-js:develop Oct 30, 2025
11 of 12 checks passed
@kgryte
Copy link
Member

kgryte commented Oct 30, 2025

Thank you for your contribution and congratulations on your first PR!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Fix JavaScript lint errors

3 participants