Skip to content

docs: improve doctests for complex number typed arrays in constants#11979

Open
anandkaranubc wants to merge 1 commit intostdlib-js:developfrom
anandkaranubc:update-constants-docs-types
Open

docs: improve doctests for complex number typed arrays in constants#11979
anandkaranubc wants to merge 1 commit intostdlib-js:developfrom
anandkaranubc:update-constants-docs-types

Conversation

@anandkaranubc
Copy link
Copy Markdown
Contributor

Progresses #4833
Resolves stdlib-js/metr-issue-tracker#521

Description

What is the purpose of this pull request?

This pull request:

  • improve doctests for complex number instances in constants

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

Questions

Any questions for reviewers of this pull request?

No.

Other

Any other information relevant to this pull request? This may include screenshots, references, and/or implementation notes.

No.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

AI Assistance

When authoring the changes proposed in this PR, did you use any kind of 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

If you answered "yes" to using AI assistance, please provide a short disclosure indicating how you used AI assistance. This helps reviewers determine how much scrutiny to apply when reviewing your contribution. Example disclosures: "This PR was written primarily by Claude Code." or "I consulted ChatGPT to understand the codebase, but the proposed changes were fully authored manually by myself.".

Used a Cursor driven Skill+Workflow to achieve this migration with manual and automated sanity checks.


@stdlib-js/reviewers

---
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: na
  - task: lint_javascript_src
    status: na
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - 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
---
@anandkaranubc anandkaranubc requested a review from a team May 6, 2026 20:15
@anandkaranubc anandkaranubc added Documentation Improvements, additions, or changes to documentation. difficulty: 1 Low degree of difficulty. Should be straightforward to implement and/or resolve. METR Pull request associated with the METR project. labels May 6, 2026
@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label May 6, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
constants/complex128/nan $\color{green}50/50$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{green}50/50$
$\color{green}+100.00%$
constants/complex128/zero $\color{green}50/50$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{green}50/50$
$\color{green}+100.00%$
constants/complex64/nan $\color{green}50/50$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{green}50/50$
$\color{green}+100.00%$
constants/complex64/zero $\color{green}50/50$
$\color{green}+100.00%$
$\color{green}1/1$
$\color{green}+100.00%$
$\color{green}0/0$
$\color{green}+100.00%$
$\color{green}50/50$
$\color{green}+100.00%$

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

@anandkaranubc
Copy link
Copy Markdown
Contributor Author

@kgryte I would still need your opinion on whether this is the right change to make. Our README files currently have slightly different code snippets than the index.js example files. This was present before too, mainly with the console.log statements being absent in the README example snippets.

Should I keep them both exactly the same as we usually do? If yes, should both follow the index.js file format?

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. METR Pull request associated with the METR project. Needs Review A pull request which needs code review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[RFC]: improve doctests for complex number typed arrays in @stdlib/constants

2 participants