docs: add notes content to blas/ext/base/ndarray/gjoin README#12037
Merged
Conversation
…ADME Populates an empty `<section class="notes">` wrapper with bullets describing the empty-input return value and null/undefined element serialization. The behavior is documented in the underlying `@stdlib/blas/ext/base/gjoin` Notes and matches the wrapping convention used by 86 of 87 sibling packages in `blas/ext/base/ndarray` (98.9% conformance).
stdlib-bot
added
the
BLAS
Contributor
Coverage ReportNo coverage information available. |
kgryte
added
Documentation
kgryte
changed the title
blas/ext/base/ndarray/gjoin READMEblas/ext/base/ndarray/gjoin README
kgryte
approved these changes
May 10, 2026
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
4 participants
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:
<section class="notes">wrapper inblas/ext/base/ndarray/gjoin/README.md. The package previously shipped the wrapper without a## Notesheading or any bullets — 86 of 87 sibling packages inblas/ext/base/ndarrayship populated Notes content (98.9% conformance).blas/ext/base/ndarray/gjoinThe README's
<section class="notes">block was empty. Two bullets were added, derived from the underlying@stdlib/blas/ext/base/gjoinNotes (the strided base this package wraps) and adapted to ndarray phrasing using the same translation pattern other ndarray wrappers in the namespace already follow (e.g.,dnansum,dindex-of):If provided an empty one-dimensional ndarray, the function returns an empty string.— the wrapper passesnumelDimension(x, 0)asNto the strided implementation, which returns''whenN <= 0.If an array element is either null or undefined, the function will serialize the element as an empty string.— matches the strided implementation's element handling viaisUndefinedOrNull.The strided base's third bullet (array-like accessor support) is intentionally omitted: it does not surface to ndarray callers, who pass ndarrays rather than array-like objects.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
This PR was authored by Claude Code as part of a cross-package API drift detection routine across the
blas/ext/base/ndarraynamespace. The Notes content was derived mechanically from the underlying@stdlib/blas/ext/base/gjoinNotes section, with the proposed correction reviewed by three independent validation agents (semantic, cross-reference, structural) before application.@stdlib-js/reviewers
Generated by Claude Code