Skip to content

Conversation

@ivishal-g
Copy link
Contributor

@ivishal-g ivishal-g commented Jan 15, 2026

Ref: #8641 .

Description

What is the purpose of this pull request?

This pull request:

  • This pull request updates documentation examples for math/base/special/cfloor to use complex number instance notation (e.g., returns [ -3.15, 3.14 ]) instead of decomposing values using realf and imagf, in accordance with the RFC guidance.

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

{{TODO: add disclosure if applicable}}


@stdlib-js/reviewers

ivishal-g and others added 8 commits January 5, 2026 15:26
---
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: 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: passed
  - 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 Good First PR A pull request resolving a Good First Issue. Math Issue or pull request specific to math functionality. Needs Review A pull request which needs code review. and removed Good First PR A pull request resolving a Good First Issue. labels Jan 15, 2026
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Jan 15, 2026

Coverage Report

Package Statements Branches Functions Lines
math/base/special/cfloor $\color{green}182/182$
$\color{green}+0.00%$
$\color{green}5/5$
$\color{green}+0.00%$
$\color{green}2/2$
$\color{green}+0.00%$
$\color{green}182/182$
$\color{green}+0.00%$

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

Signed-off-by: Vishal Gaikwad <[email protected]>
@ivishal-g ivishal-g changed the title docs: improve doctests for complex number instances in math/base/special/cfloor docs: improve doctests for complex number instances in math/base/special/cfloor Jan 15, 2026
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 Jan 16, 2026
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Jan 16, 2026
@stdlib-bot
Copy link
Contributor

PR Commit Message

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

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

Reviewed-by: Philipp Burckhardt <[email protected]>
Signed-off-by: Vishal Gaikwad <[email protected]>

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 8da46ee into stdlib-js:develop Jan 16, 2026
34 checks passed
@stdlib-bot stdlib-bot removed the Ready To Merge A pull request which is ready to be merged. label Jan 16, 2026
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