Skip to content

docs: remove stray err handling in examples and enable lint rule#11556

Merged
kgryte merged 4 commits intodevelopfrom
philipp/fix-commit-review-2026-04-18
Apr 19, 2026
Merged

docs: remove stray err handling in examples and enable lint rule#11556
kgryte merged 4 commits intodevelopfrom
philipp/fix-commit-review-2026-04-18

Conversation

@Planeshifter
Copy link
Copy Markdown
Member

@Planeshifter Planeshifter commented Apr 18, 2026

Description

What is the purpose of this pull request?

This pull request:

  • Applies follow-up fixes for commits merged to develop on 2026-04-18 (SHA range 3af178cc07..414d61b8ad).
  • napi/create-int64 (0c116e3d): drop the if ( err != NULL ) { napi_throw(...); } block from the @example and README — it was copy-pasted from argv-int64 and references an undeclared err that stdlib_napi_create_int64 never produces; coerce the BigInt return via Number() in test.native.js so strictEqual no longer fails on 5n === 5.
  • napi/create-uint64 (0c116e3d): same stray err-block removal in the @example and README, add the "generated JavaScript value is a BigInt" note to the C API notes section to match the sibling create-int64, and coerce the BigInt return via Number() in test.native.js for the same reason as above.
  • ndarray/colcat (648e90d0): add the missing <!-- eslint no-undef: "error" --> directive before the Examples code fence; every other @stdlib/ndarray top-level README uses it.

Related Issues

Does this pull request have any related issues?

None.

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request?

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of AI assistance?

  • Yes
  • No

If you answered "yes" above, how did you use AI assistance?

  • Code generation (e.g., when writing an implementation or fixing a bug)
  • Test/benchmark generation
  • Documentation (including examples)
  • Research and understanding

Disclosure

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance.

PR authored by Claude Code: sub-agents reviewed the 24-hour commit window on develop; main agent validated each finding and applied the fixes.


@stdlib-js/reviewers

claude added 3 commits April 18, 2026 22:35
…create-int64

The @example block and README C example referenced an err variable
that stdlib_napi_create_int64 never produces; the native test also
compared the returned BigInt to a Number via strictEqual.
…ia Number in napi/create-uint64

The @example block and README C example referenced an err variable
that stdlib_napi_create_uint64 never produces; added the missing C API
note that the generated JavaScript value is a BigInt (matching
create-int64); the native test compared the returned BigInt to a
Number via strictEqual.
…es block

Matches the convention used across every other @stdlib/ndarray
top-level README.
@stdlib-bot
Copy link
Copy Markdown
Contributor

stdlib-bot commented Apr 18, 2026

Coverage Report

Package Statements Branches Functions Lines
napi/create-int64 $\color{green}147/147$
$\color{green}+0.00%$
$\color{green}5/5$
$\color{green}+0.00%$
$\color{green}1/1$
$\color{green}+0.00%$
$\color{green}147/147$
$\color{green}+0.00%$
napi/create-uint64 $\color{green}147/147$
$\color{green}+0.00%$
$\color{green}5/5$
$\color{green}+0.00%$
$\color{green}1/1$
$\color{green}+0.00%$
$\color{green}147/147$
$\color{green}+0.00%$
ndarray/colcat $\color{green}284/284$
$\color{green}+0.00%$
$\color{green}42/42$
$\color{green}+0.00%$
$\color{green}2/2$
$\color{green}+0.00%$
$\color{green}284/284$
$\color{green}+0.00%$

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

@stdlib-js stdlib-js deleted a comment from stdlib-bot Apr 18, 2026
@Planeshifter Planeshifter force-pushed the philipp/fix-commit-review-2026-04-18 branch from d536608 to 3b18bd6 Compare April 18, 2026 22:45
@Planeshifter Planeshifter changed the title fix: follow-up corrections for commits merged to develop on 2026-04-18 fix: remove stray err handling and fix BigInt tests in napi/create-int64 and napi/create-uint64 Apr 19, 2026
@Planeshifter Planeshifter marked this pull request as ready for review April 19, 2026 04:56
@Planeshifter Planeshifter requested review from a team and kgryte April 19, 2026 04:56
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Apr 19, 2026
Comment thread lib/node_modules/@stdlib/napi/create-int64/test/test.native.js Outdated
Comment thread lib/node_modules/@stdlib/napi/create-uint64/test/test.native.js Outdated
…api/create-uint64 native tests

The lib/native.js wrapper already coerces the addon return value via
Number(), so the prior strictEqual was sound. Drop the redundant
Number() coercion and the unused @stdlib/number/ctor import.
@kgryte kgryte removed the Needs Review A pull request which needs code review. label Apr 19, 2026
@kgryte kgryte changed the title fix: remove stray err handling and fix BigInt tests in napi/create-int64 and napi/create-uint64 docs: remove stray err handling in examples and enable lint rule Apr 19, 2026
@kgryte kgryte added the Documentation Improvements, additions, or changes to documentation. label Apr 19, 2026
@kgryte kgryte merged commit e08ef82 into develop Apr 19, 2026
35 checks passed
@kgryte kgryte deleted the philipp/fix-commit-review-2026-04-18 branch April 19, 2026 05:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants