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 the documentation examples for the array/base/at package to use the new compact complex instance doctest notation.
  • Removes example usage of real, imag, realf, and imagf which were previously used to decompose complex numbers into real and imaginary components.
  • Replaces those decomposed return annotations with direct complex instance annotations such as:
    • // returns <Complex128>[ 1.0, 2.0 ]
    • // returns <Complex128>[ 3.0, 4.0 ]
    • // returns <Complex128>[ 5.0, 6.0 ]
    • // returns <Complex64>[ 1.0, 2.0 ]
    • // returns <Complex64>[ 3.0, 4.0 ]
    • // returns <Complex64>[ 5.0, 6.0 ]
  • Ensures consistency with the recent RFC and the updated doctest framework which now supports complex instance notation.

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

(Replace the placeholder above with the actual issue number.)

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.

  • Read, understood, and followed the contributing guidelines.
  • Updated only the examples for the array/base/at package.
  • Ensured no functional code was modified.
  • Followed the doctest formatting conventions described in the RFC.

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.

Only for research purpose , else everything i done it myself


@stdlib-js/reviewers

@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
array/base/at $\color{green}138/138$
$color{green}+100.00%$
$\color{green}9/9$
$color{green}+100.00%$
$\color{green}2/2$
$color{green}+100.00%$
$\color{green}138/138$
$color{green}+100.00%$

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

@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 @stdlib/array/base/at docs: improve doctests for complex number instances in array/base/at 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>
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 clean-up

Signed-off-by: Athan <kgryte@gmail.com>
@kgryte kgryte merged commit db85f69 into stdlib-js:develop Dec 1, 2025
11 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. 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