Skip to content

docs: improve doctests for complex number instances in strided/base/zmap #9044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
prajjwalbajpai wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

docs: improve doctests for complex number instances in strided/base/zmap #9044

prajjwalbajpai wants to merge 1 commit into from
+18 −116

Conversation

@prajjwalbajpai
Copy link
Contributor

@prajjwalbajpai prajjwalbajpai commented Dec 14, 2025 •
edited
Loading

Resolves a part of #8641.

Description

This pull request:

  • Updates REPL and documentation examples in the strided/base/zmap to use the compact complex instance doctest notation.
  • Replaces example decomposition using realf/imagf with concise doctest annotations.

Related Issues

This pull request has the following related issues:

Questions

No.

Other

No.

Checklist

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

N.A.

@stdlib-js/reviewers

@prajjwalbajpai
docs: improve doctests for complex number instances in `strided/base/…
1880ec6 
…zmap`

---
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: passed
  - task: lint_package_json
    status: na
  - task: lint_repl_help
    status: passed
  - 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: passed
  - 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 14, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Dec 14, 2025

Coverage Report

Package Statements Branches Functions Lines
strided/base/zmap $\color{green}226/226$
$\color{green}+100.00%$ 		$\color{green}9/9$
$\color{green}+100.00%$ 		$\color{green}2/2$
$\color{green}+100.00%$ 		$\color{green}226/226$
$\color{green}+100.00%$

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

@stdlib-bot
Copy link
Contributor

stdlib-bot commented Dec 15, 2025

⚠️ Tracking Issue Closure Warning ⚠️

I noticed your PR description contains closing keywords ("Resolves", "Closes", or "Fixes") referencing a "Tracking Issue".

Why this matters:
Tracking issues should typically remain open until all related sub-issues are completed. GitHub automatically closes issues with such closing keywords when the PR is merged. For more information, see GitHub's documentation on using keywords in issues and pull requests.

Required action:
Use "Progresses" instead to reference the tracking issue without automatically closing it.

Thank you for your contribution to the project!

@stdlib-bot stdlib-bot added Potential Duplicate There might be another pull request resolving the same issue. and removed Potential Duplicate There might be another pull request resolving the same issue. labels Dec 15, 2025
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Dec 16, 2025
kgryte
kgryte reviewed Dec 16, 2025
View reviewed changes
lib/node_modules/@stdlib/strided/base/zmap/README.md
zmap( x.length, x, 1, y, 1, cceil );

var v = y.get( 0 );
// returns <Complex128>
Copy link
Member

@kgryte kgryte Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prajjwalbajpai You also need to remove any applicable import statements above and below in this file.

kgryte
kgryte reviewed Dec 16, 2025
View reviewed changes
lib/node_modules/@stdlib/strided/base/zmap/docs/types/index.d.ts
*
* var im = imag( v );
* // returns 10.0
* // returns <Complex128>[ 10.0, 10.0 ]
Copy link
Member

@kgryte kgryte Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prajjwalbajpai You need to remove any applicable import statements in this and other examples in this file.

kgryte
kgryte reviewed Dec 16, 2025
View reviewed changes
lib/node_modules/@stdlib/strided/base/zmap/lib/index.js
*
* var im = imag( v );
* // returns 10.0
* // returns <Complex128>[ 10.0, 10.0 ]
Copy link
Member

@kgryte kgryte Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prajjwalbajpai You need to remove any applicable import statements in this and other examples in this file.

kgryte
kgryte reviewed Dec 16, 2025
View reviewed changes
lib/node_modules/@stdlib/strided/base/zmap/lib/main.js
*
* var im = imag( v );
* // returns 10.0
* // returns <Complex128>[ 10.0, 10.0 ]
Copy link
Member

@kgryte kgryte Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prajjwalbajpai You need to remove any applicable import statements in this and other examples in this file.

kgryte
kgryte reviewed Dec 16, 2025
View reviewed changes
lib/node_modules/@stdlib/strided/base/zmap/lib/ndarray.js
*
* var im = imag( v );
* // returns 10.0
* // returns <Complex128>[ 10.0, 10.0 ]
Copy link
Member

@kgryte kgryte Dec 16, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@prajjwalbajpai You need to remove any applicable import statements in this and other examples in this file.

kgryte
kgryte requested changes Dec 16, 2025
View reviewed changes
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.

Left initial comments.

@kgryte kgryte added the Needs Changes Pull request which needs changes before being merged. label Dec 16, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@kgryte kgryte kgryte requested changes

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

Documentation Improvements, additions, or changes to documentation. Good First PR A pull request resolving a Good First Issue. Needs Changes Pull request which needs changes before being merged.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@prajjwalbajpai @stdlib-bot @kgryte