Skip to content

Comments

docs: improve doctests for complex number instances in ndarray/base/unary#8999

Merged
kgryte merged 3 commits intostdlib-js:developfrom
aryan7071:docs-improve_ndarray/base/unary
Jan 14, 2026
Merged

docs: improve doctests for complex number instances in ndarray/base/unary#8999
kgryte merged 3 commits intostdlib-js:developfrom
aryan7071:docs-improve_ndarray/base/unary

Conversation

@aryan7071
Copy link
Contributor

@aryan7071 aryan7071 commented Dec 12, 2025


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 status: na
  • task: lint_package_json status: na
  • task: lint_repl_help status: na
  • task: lint_javascript_src status: passed
  • 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: na
  • task: lint_license_headers status: passed ---

Resolves part of #8641

Description

This pull request updates documentation examples for ndarray/base/unary/lib to use complex number instance notation (e.g., <Complex64>[ 10.0, 20.0 ]) instead of decomposing values using realf and imagf, in accordance with the RFC guidance.

No functional code changes were made. Only documentation examples were updated.

Related Issues

Questions

No.

Other

No.

Checklist

AI Assistance

  • No
  • Yes

Disclosure

N/A


@stdlib-js/reviewers

…nary/lib

---
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
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - 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: na
  - task: lint_license_headers
    status: passed
---
@stdlib-bot stdlib-bot added Needs Review A pull request which needs code review. Good First PR A pull request resolving a Good First Issue. labels Dec 12, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Dec 12, 2025

Coverage Report

Package Statements Branches Functions Lines
ndarray/base/unary $\color{green}10548/10548$
$\color{green}+0.00%$
$\color{green}690/690$
$\color{green}+0.00%$
$\color{green}43/43$
$\color{green}+0.00%$
$\color{green}10548/10548$
$\color{green}+0.00%$

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

@kgryte kgryte changed the title docs: improve doctests for complex number instances in ndarray/base/unary/lib docs: improve doctests for complex number instances in ndarray/base/unary Dec 20, 2025
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Dec 20, 2025
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.

In order for this PR to move forward, the realf and imagf imports need to be restored and the scale callback restored.

@kgryte kgryte added the Needs Changes Pull request which needs changes before being merged. label Dec 20, 2025
@aryan7071
Copy link
Contributor Author

ok i am going to revert this change

…nary

---
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
    status: na
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: na
  - task: lint_javascript_src
    status: passed
  - 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: na
  - task: lint_license_headers
    status: passed
---
@aryan7071 aryan7071 requested a review from kgryte January 11, 2026 18:04
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jan 11, 2026
@kgryte kgryte added difficulty: 1 Low degree of difficulty. Should be straightforward to implement and/or resolve. and removed Needs Review A pull request which needs code review. Needs Changes Pull request which needs changes before being merged. labels Jan 14, 2026
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

@kgryte kgryte merged commit e2c03c0 into stdlib-js:develop Jan 14, 2026
28 checks passed
nakul-krishnakumar pushed a commit to nakul-krishnakumar/stdlib that referenced this pull request Jan 25, 2026
…unary`

PR-URL: stdlib-js#8999
Ref: stdlib-js#8641
Co-authored-by: Athan Reines <kgryte@gmail.com>
Reviewed-by: Athan Reines <kgryte@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

difficulty: 1 Low degree of difficulty. Should be straightforward to implement and/or resolve. Documentation Improvements, additions, or changes to documentation. Good First PR A pull request resolving a Good First Issue. review: 3

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants