Skip to content

docs: improve doctests for complex number instances - #16532

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

kgryte merged 1 commit into
stdlib-js:developfrom
Mustansir-06:docs-complex-doctests-complex-float32-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/float32/parse to use complex number instance notation (<Complex64>[ 5.0, 3.0 ]) instead of decomposing the parsed value with real and imag.
  • removes the real and imag requires 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:

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 as a model. I'm on Windows and was not able to run the project's lint checks locally, so I'm relying on CI for those.

Checklist

Please ensure the following tasks are completed before submitting this pull request.

@stdlib-js/reviewers

@Mustansir-06
Mustansir-06 requested a review from a team November 7, 2026 13:56
@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 7, 2026
@stdlib-bot

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
complex/float32/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 8, 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 changed the title docs: improve doctests for complex number instances in complex/float32/parse docs: improve doctests for complex number instances Nov 8, 2026
@kgryte
kgryte merged commit 5427b02 into stdlib-js:develop Nov 8, 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