Skip to content

Conversation

@aryan7071
Copy link
Contributor

@aryan7071 aryan7071 commented Nov 30, 2025

Resolves a part of #8641

Description

What is the purpose of this pull request?

This pull request:

  • Updates REPL and documentation examples in the complex/base/cast-return package to use the compact complex instance doctest notation.
  • Replaces example decomposition using realf/imagf with concise doctest annotations such as <Complex64>[ 7.0, 0.0 ].
  • Removes example-only imports (realf, imagf) where they were only used to show decomposed values.
  • Keeps all edits documentation-only (no runtime behavior or type changes).

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

(Replace the placeholder above with the relevant issue number if applicable.)

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.

N/A


@stdlib-js/reviewers

@stdlib-bot
Copy link
Contributor

Hello! Thank you for your contribution to stdlib.

We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:

  1. Please read our contributing guidelines.

  2. Update your pull request description to include this checked box:

    - [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

  • The developer's certificate of origin
  • Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

@stdlib-bot stdlib-bot added First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Needs Review A pull request which needs code review. Good First PR A pull request resolving a Good First Issue. labels Nov 30, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Nov 30, 2025

Coverage Report

Package Statements Branches Functions Lines
complex/base/cast-return $\color{green}250/250$
$color{green}+100.00%$
$\color{green}26/26$
$color{green}+100.00%$
$\color{green}8/8$
$color{green}+100.00%$
$\color{green}250/250$
$color{green}+100.00%$

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

@stdlib-bot
Copy link
Contributor

Hello! Thank you for your contribution to stdlib.

We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:

  1. Please read our contributing guidelines.

  2. Update your pull request description to include this checked box:

    - [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

  • The developer's certificate of origin
  • Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

@stdlib-bot
Copy link
Contributor

⚠️ Tracking Issue Closure Warning ⚠️

I noticed your PR description contains closing keywords ("Resolves", "Closes", or "Fixes") referencing a "Tracking Issue".

Why this matters:
Tracking issues should typically remain open until all related sub-issues are completed. GitHub automatically closes issues with such closing keywords when the PR is merged. For more information, see GitHub's documentation on using keywords in issues and pull requests.

Required action:
Use "Progresses" instead to reference the tracking issue without automatically closing it.

Thank you for your contribution to the project!

@stdlib-bot stdlib-bot added Potential Duplicate There might be another pull request resolving the same issue. and removed First-time Contributor A pull request from a contributor who has never previously committed to the project repository. labels Dec 1, 2025
@kgryte kgryte changed the title Docs/improve doctests complex/base/cast-return docs: improve doctests for complex number instances in complex/base/cast-return Dec 1, 2025
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Dec 1, 2025
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
kgryte
kgryte previously approved these changes Dec 1, 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 after considerable clean-up.

@aryan7071 Please ensure you have read and followed our contributing guidelines. It is clear from a number of mistakes made in this PR that you have not properly setup your local dev env.

Signed-off-by: Athan <kgryte@gmail.com>
@kgryte kgryte merged commit 2b72de4 into stdlib-js:develop Dec 1, 2025
12 checks passed
@aryan7071
Copy link
Contributor Author

aryan7071 commented Dec 1, 2025

Thank you for the feedback. I will review the contributing guidelines again and make sure my local dev env is set up correctly. I’ll follow the project’s conventions more closely in future contributions. Thank you for the guidance.

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. Potential Duplicate There might be another pull request resolving the same issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants