Skip to content

docs: improve doctests for complex number instances in complex/float64/parse - #16554

Merged
kgryte merged 1 commit into
stdlib-js:developfrom
Mustansir-06:docs-complex-doctests-complex-float64-parse
Nov 10, 2026
Merged

kgryte merged 1 commit into
stdlib-js:developfrom
Mustansir-06:docs-complex-doctests-complex-float64-parse

Conversation

@Mustansir-06

Copy link
Copy Markdown
Contributor

Resolves None.

Description

What is the purpose of this pull request?

This pull request:

  • updates the Usage example in the README.md of complex/float64/parse to use complex number instance notation (<Complex128>[ 5.0, 3.0 ]) instead of decomposing the parsed value with real and imag.
  • removes the real and imag require statements from that example, as they are no longer used there.

The Examples section is unchanged, since it uses real and imag for value checks rather than for showing expected output.

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

Reference Packages

Did the content of this pull request follow one or more existing packages? Answering is optional.

This pull request followed these packages:

  • Commit e8c8651 and PR #16532

What carried over from the reference(s)?

  • Package structure, documentation patterns, and implementation conventions from commit e8c8651 and PR #16532.

What differed, or what did you have to work out yourself?

  • Simplified the README Usage section to use <Complex128>[ 5.0, 3.0 ] without requiring real and imag, while retaining them in the Examples section where explicit property checks are performed.

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.

I followed the changes in commit e8c8651 and PR #16532 as a model.

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

N/A

@stdlib-js/reviewers

@Mustansir-06
Mustansir-06 requested a review from a team November 9, 2026 14:15
@stdlib-bot stdlib-bot added Needs Review A pull request which needs code review. Good First PR A pull request resolving a Good First Issue. labels Nov 9, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
complex/float64/parse $\\color{green}102/102$
$\\color{green}+100.00\\%$
$\\color{green}7/7$
$\\color{green}+100.00\\%$
$\\color{green}1/1$
$\\color{green}+100.00\\%$
$\\color{green}102/102$
$\\color{green}+100.00\\%$

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

@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. difficulty: 1 Low degree of difficulty. Should be straightforward to implement and/or resolve. review: 5 and removed Needs Review A pull request which needs code review. labels Nov 10, 2026

@kgryte kgryte left a comment

Copy link
Copy Markdown
Member

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 68c982b into stdlib-js:develop Nov 10, 2026
97 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

difficulty: 1 Low degree of difficulty. Should be straightforward to implement and/or resolve. Documentation Improvements, additions, or changes to documentation. Good First PR A pull request resolving a Good First Issue. review: 5

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants