Skip to content

Comments

docs: improve doctests for complex number instances in math/base/special/cround#9025

Merged
Planeshifter merged 2 commits intostdlib-js:developfrom
prajjwalbajpai:math/cround-cmplx-doctest
Dec 13, 2025
Merged

docs: improve doctests for complex number instances in math/base/special/cround#9025
Planeshifter merged 2 commits intostdlib-js:developfrom
prajjwalbajpai:math/cround-cmplx-doctest

Conversation

@prajjwalbajpai
Copy link
Contributor

@prajjwalbajpai prajjwalbajpai commented Dec 13, 2025

Resolves part of #8641.

Description

This pull request:

  • Updates REPL and documentation examples in the math/base/special/cround 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

N.A.


@stdlib-js/reviewers

…ial/cround

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

Hello! 👋

We've noticed that you've been opening a number of PRs addressing good first issues. Thank you for your interest and enthusiasm!

Now that you've made a few contributions, we suggest no longer working on good first issues. Instead, we encourage you to prioritize cleaning up any PRs which have yet to be merged and then proceed to work on more involved tasks.

Not only does this ensure that other new contributors can work on things and get ramped up on all things stdlib, it also ensures that you can spend your time on more challenging problems. 🚀

For ideas for future PRs, feel free to search the codebase for TODOs and FIXMEs and be sure to check out other open issues on the issue tracker. Cheers!

@stdlib-bot
Copy link
Contributor

stdlib-bot commented Dec 13, 2025

Coverage Report

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

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

Signed-off-by: Philipp Burckhardt <pburckhardt@outlook.com>
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 changed the title docs: improve doctests for complex number instances in math/base/special/cround docs: improve doctests for complex number instances in math/base/special/cround Dec 13, 2025
@Planeshifter Planeshifter added the Ready To Merge A pull request which is ready to be merged. label Dec 13, 2025
@stdlib-bot stdlib-bot removed the Needs Review A pull request which needs code review. label Dec 13, 2025
@stdlib-bot
Copy link
Contributor

PR Commit Message

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

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

Co-authored-by: Philipp Burckhardt <pburckhardt@outlook.com>
Reviewed-by: Philipp Burckhardt <pburckhardt@outlook.com>
Signed-off-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 2c59b22 into stdlib-js:develop Dec 13, 2025
34 checks passed
@stdlib-bot stdlib-bot removed the Ready To Merge A pull request which is ready to be merged. label Dec 13, 2025
@prajjwalbajpai prajjwalbajpai deleted the math/cround-cmplx-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

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