fix: widen mode option type in ndarray/sub2ind to accept a single mode#12628
Draft
Planeshifter wants to merge 1 commit into
Draft
fix: widen mode option type in ndarray/sub2ind to accept a single mode#12628Planeshifter wants to merge 1 commit into
mode option type in ndarray/sub2ind to accept a single mode#12628Planeshifter wants to merge 1 commit into
Conversation
… mode
The `mode` option was typed as `Array<string>`, but the implementation
also accepts a single mode string (e.g. `{ 'mode': 'wrap' }`), and the
element type should be the `Mode` union rather than a loose `string`.
Import `Mode` and type the option as `Mode | Array<Mode>`, mirroring the
sibling `ind2sub` package, and add a positive single-string test case.
Also corrects the accompanying declaration TSDoc: adds the missing
`@throws options argument must be an object` (thrown by the
implementation), fixes the `much match` -> `must match` typo, and
capitalizes the `order` option description for consistency with the
`mode` description.
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
- task: lint_filenames
status: passed
- task: lint_editorconfig
status: passed
- task: lint_markdown_pkg_readmes
status: na
- task: lint_markdown_docs
status: na
- task: lint_markdown
status: na
- task: lint_package_json
status: na
- task: lint_repl_help
status: na
- task: lint_javascript_src
status: na
- task: lint_javascript_cli
status: na
- task: lint_javascript_examples
status: na
- task: lint_javascript_tests
status: na
- task: lint_javascript_benchmarks
status: na
- task: lint_python
status: na
- task: lint_r
status: na
- task: lint_c_src
status: na
- task: lint_c_examples
status: na
- task: lint_c_benchmarks
status: na
- task: lint_c_tests_fixtures
status: na
- task: lint_shell
status: na
- task: lint_typescript_declarations
status: passed
- task: lint_typescript_tests
status: passed
- task: lint_license_headers
status: passed
---
Contributor
Coverage Report
The above coverage report was generated for the changes in this PR. |
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
2 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:
modeoption type in the@stdlib/ndarray/sub2inddeclaration fromArray<string>toMode | Array<Mode>. The implementation accepts a single mode string (e.g.{ 'mode': 'wrap' }), which the previous type rejected, and the element type should be theModeunion rather than a loosestring(mirroring the siblingind2subpackage). Also adds the missing@throws options argument must be an object, fixes amuch match->must matchtypo, capitalizes theorderoption description, and adds a positive single-stringmodetest case.Related Issues
No.
Questions
No.
Other
Found during a TypeScript-declaration audit of the
ndarraynamespace.Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
These changes were identified by a Claude Code audit of the
ndarraynamespace's TypeScript declarations and applied with Claude Code assistance; the changes were reviewed by myself.@stdlib-js/reviewers