Skip to content

docs: fix comments and returns description#10015

Merged
kgryte merged 1 commit intostdlib-js:developfrom
Sachinn-64:fix-inconsistency
Jan 31, 2026
Merged

docs: fix comments and returns description#10015
kgryte merged 1 commit intostdlib-js:developfrom
Sachinn-64:fix-inconsistency

Conversation

@Sachinn-64
Copy link
Copy Markdown
Member

@Sachinn-64 Sachinn-64 commented Jan 31, 2026

Resolves None.

Description

What is the purpose of this pull request?

This pull request:

  • fix: correct argument position comments in complex/float64/base/add3 and fix incorrect @returns description in stats/strided/nanrange

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

  • None

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

{{TODO: add disclosure if applicable}}


@stdlib-js/reviewers

@stdlib-bot stdlib-bot added the Needs Review A pull request which needs code review. label Jan 31, 2026
@Sachinn-64 Sachinn-64 changed the title fix: correct argument position comments in complex/float64/base/add3 and fix incorrect @returns description in stats/strided/nanrange fix: comments in complex/float64/base/add3 and fix incorrect @returns description in stats/strided/nanrange Jan 31, 2026
@stdlib-bot
Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
complex/float64/base/add3 $\color{green}274/274$
$\color{green}+100.00%$
$\color{green}9/9$
$\color{green}+100.00%$
$\color{green}4/4$
$\color{green}+100.00%$
$\color{green}274/274$
$\color{green}+100.00%$
stats/strided/nanrange $\color{green}310/310$
$\color{green}+100.00%$
$\color{green}47/47$
$\color{green}+100.00%$
$\color{green}3/3$
$\color{green}+100.00%$
$\color{green}310/310$
$\color{green}+100.00%$

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

@kgryte kgryte changed the title fix: comments in complex/float64/base/add3 and fix incorrect @returns description in stats/strided/nanrange docs: fix comments and returns description Jan 31, 2026
@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. difficulty: 1 Low degree of difficulty. Should be straightforward to implement and/or resolve. and removed Needs Review A pull request which needs code review. labels Jan 31, 2026
Copy link
Copy Markdown
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. Thanks for addressing, @Sachinn-64!

@kgryte kgryte merged commit ee4e852 into stdlib-js:develop Jan 31, 2026
96 checks passed
DivitJain26 pushed a commit to DivitJain26/stdlib-divit that referenced this pull request Feb 25, 2026
PR-URL: stdlib-js#10015
Reviewed-by: Athan Reines <kgryte@gmail.com>
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. review: 5

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants