Skip to content

Comments

docs: improve doctests for complex number instances in math/base/special/cfloorn#9284

Merged
kgryte merged 1 commit intostdlib-js:developfrom
aryan7071:docs-improve_math/base/special/cfloorn
Dec 20, 2025
Merged

docs: improve doctests for complex number instances in math/base/special/cfloorn#9284
kgryte merged 1 commit intostdlib-js:developfrom
aryan7071:docs-improve_math/base/special/cfloorn

Conversation

@aryan7071
Copy link
Contributor


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 ---

Resolves part of #8641

Description

This pull request updates documentation examples for math/base/special/cfloorn to use complex number instance notation (e.g., returns <Complex128>[ -3.15, 3.14 ]) 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/cfloorn

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

Coverage Report

Package Statements Branches Functions Lines
math/base/special/cfloorn $\color{green}179/179$
$\color{green}+100.00%$
$\color{green}5/5$
$\color{green}+100.00%$
$\color{green}2/2$
$\color{green}+100.00%$
$\color{green}179/179$
$\color{green}+100.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 math/base/special/cfloorn docs: improve doctests for complex number instances in math/base/special/cfloorn 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.

LGTM

@kgryte kgryte merged commit 9d2d2d0 into stdlib-js:develop Dec 20, 2025
89 checks passed
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. Math Issue or pull request specific to math functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants