Skip to content

docs: improve doctests for complex number instances in strided/base/cmap#8954

Merged
kgryte merged 1 commit intostdlib-js:developfrom
prajjwalbajpai:cmap-doctest
Dec 15, 2025
Merged

docs: improve doctests for complex number instances in strided/base/cmap#8954
kgryte merged 1 commit intostdlib-js:developfrom
prajjwalbajpai:cmap-doctest

Conversation

@prajjwalbajpai
Copy link
Copy Markdown
Contributor

Resolves a part of #8641.

Description

This pull request:

  • Updates REPL and documentation examples in the strided/base/cmap package 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

NA


@stdlib-js/reviewers

…cmap`

---
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: 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 10, 2025
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
strided/base/cmap $\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.

@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Dec 15, 2025
Copy link
Copy Markdown
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 3de4c3c into stdlib-js:develop Dec 15, 2025
68 checks passed
@prajjwalbajpai prajjwalbajpai deleted the cmap-doctest branch December 15, 2025 11:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements, additions, or changes to documentation. Good First PR A pull request resolving a Good First Issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants