Repository navigation
docs: add examples and keywords - #16152
Merged
Merged
Conversation
Populated the empty `keywords` array in `package.json` with the namespace prefix shared by 382/383 (99.7%) siblings ("stdlib", "stdmath", "mathematics", "math") and package-specific terms following the `ellipk`/`ellipe` convention. `ellipj` was the only package in `lib/node_modules/@stdlib` with an empty `keywords` array.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01PrXnrxd4fshM1EZC9BNFTJ
Added an `@example` block to the `stdlib_base_log2` doc comment in `src/main.c`, mirroring the README C usage. Present in 374/376 (99.5%) native siblings. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PrXnrxd4fshM1EZC9BNFTJ
Added an `@example` block to the `stdlib_base_sincosdf` doc comment in `src/main.c`, mirroring `sincosf` and `sincosd`. Present in 374/376 (99.5%) native siblings. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01PrXnrxd4fshM1EZC9BNFTJ
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
kgryte
approved these changes
Oct 14, 2026
@example blocks and ellipj keywords in math/base/special
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This pull request:
@exampleblocks and populates an emptykeywordsarray, bringing threemath/base/specialpackages in line with near-universal namespace conventions.math/base/special/ellipjPopulates the empty
keywordsarray inpackage.jsonwith the namespace prefix (stdlib,stdmath,mathematics,math) used by 382/383 (99.7%) siblings, followed by package-specific terms in theellipk/ellipestyle (special,elliptic,jacobi,sn,cn,dn,am,amplitude,number).ellipjwas the only package inlib/node_modules/@stdlibwith an emptykeywordsarray.math/base/special/log2Adds an
@exampleblock to thestdlib_base_log2doc comment insrc/main.c, mirroring the README C usage (stdlib_base_log2( 4.0 )returns2.0). Present in 374/376 (99.5%) native siblings.math/base/special/sincosdfAdds an
@exampleblock to thestdlib_base_sincosdfdoc comment insrc/main.c, mirroringsincosfandsincosd. Present in 374/376 (99.5%) native siblings.Related Issues
No.
Questions
No.
Other
Namespace summary.
math/base/specialhas 383 member packages;fastis a sub-namespace and was excluded. About 90 structural and semantic features were analyzed: file tree,package.json/manifest.jsonkeys, README section sets, the JSDoc shape oflib/{index,main,native}.js, the C doc comments insrc/main.c, and the benchmark/example/test idioms. Nearly all features had a clear majority (≥75%). Two features had no clear majority and were excluded:@stdlib/string/formatinbenchmark/benchmark.js(73.9%) and@stdlib/random/arrayinexamples/index.js(74.9%).Validation. Corrections passed three independent reviews: semantic (source and README read in full), cross-reference (no test, example or tooling depends on the current state) and structural applicability. The following were deliberately excluded:
Math.*aliases (ceil,floor,round,sqrt, ...) whose JSDoc sits on a variable rather than a function; void out-parameter C functions lacking@return; variadic*npackages andsici, which have no native addon.cfloor,cceilf).@stdlib/random/arraybenchmark migration, which changes benchmark behavior.The diff changes only doc comments and metadata. It does not change behavior.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was written primarily by Claude Code as part of an automated cross-package drift analysis (majority vote across namespace siblings).
🤖 Generated with Claude Code
https://claude.ai/code/session_01PrXnrxd4fshM1EZC9BNFTJ
Generated by Claude Code