Skip to content

Comments

docs: improve doctests for complex number instances in math/base/special/cflipsignf#9011

Merged
Planeshifter merged 2 commits intostdlib-js:developfrom
aryan7071:docs-improve_math/base/special/cflipsignf
Dec 12, 2025
Merged

docs: improve doctests for complex number instances in math/base/special/cflipsignf#9011
Planeshifter merged 2 commits intostdlib-js:developfrom
aryan7071:docs-improve_math/base/special/cflipsignf

Conversation

@aryan7071
Copy link
Contributor

Resolves part of #8641

Description

This pull request updates documentation examples for math/base/special/croundn to use complex number instance notation (e.g., <Complex64>[ 4.0, -5.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

…ial/cflipsignf

---
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: 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
---
…ial/cflipsignf

---
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: 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 Math Issue or pull request specific to math functionality. 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

Coverage Report

Package Statements Branches Functions Lines
math/base/special/cflipsignf $\color{green}149/149$
$\color{green}+100.00%$
$\color{green}7/7$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}149/149$
$\color{green}+100.00%$

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

@aryan7071 aryan7071 changed the title Docs improve math/base/special/cflipsignf docs: improve doctests for complex number instances in math/base/special/cflipsignf Dec 12, 2025
Copy link
Member

@Planeshifter Planeshifter left a comment

Choose a reason for hiding this comment

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

Thanks!

@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Dec 12, 2025
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Dec 12, 2025
@stdlib-bot
Copy link
Contributor

PR Commit Message

docs: improve doctests for complex number instances in math/base/special/cflipsignf

PR-URL: https://github.com/stdlib-js/stdlib/pull/9011
Ref: https://github.com/stdlib-js/stdlib/issues/8641

Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>

Please review the above commit message and make any necessary adjustments.

⚠️ Action Required: This PR references tracking issues. Please update the PR description to replace any "Closes", "Fixes", or "Resolves" keywords with "Ref" when referencing these issues.

@Planeshifter Planeshifter merged commit 0909988 into stdlib-js:develop Dec 12, 2025
88 of 89 checks passed
@stdlib-bot stdlib-bot removed the Ready To Merge A pull request which is ready to be merged. label Dec 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Good First PR A pull request resolving a Good First Issue. Math Issue or pull request specific to math functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants