Skip to content

Conversation

@Orthodox-64
Copy link
Contributor

Resolves None.

Description

What is the purpose of this pull request?

This pull request:

  • docs: update return annotations to use ndarray instance notation in stats/range-by

Related Issues

Does this pull request have any related issues?

This pull request has the following related issues:

  • #{{TODO: add related 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.

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 Statistics Issue or pull request related to statistical functionality. Needs Review A pull request which needs code review. labels Dec 10, 2025
@stdlib-bot
Copy link
Contributor

stdlib-bot commented Dec 10, 2025

Coverage Report

Package Statements Branches Functions Lines
stats/range-by $\color{green}161/161$
$\color{green}+0.00%$
$\color{green}2/2$
$\color{green}+0.00%$
$\color{green}0/0$
$\color{green}+0.00%$
$\color{green}161/161$
$\color{green}+0.00%$

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

@kgryte kgryte added Documentation Improvements, additions, or changes to documentation. and removed Needs Review A pull request which needs code review. labels Dec 15, 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. Note that many of the annotations in the README were incorrect, especially with incorrect dimensionality. The dimensionality of the nested array in the return annotation should match the dimensionality of the ndarray.

@kgryte kgryte merged commit 1a8cc79 into stdlib-js:develop Dec 15, 2025
12 checks passed
@Orthodox-64
Copy link
Contributor Author

Thanks @kgryte! Noted — I’ll make sure the README annotations and dimensionality are correct going forward.

@kgryte
Copy link
Member

kgryte commented Dec 15, 2025

@Orthodox-64 Ideally, our doctest linter would catch when the dimensionality is incorrect. So it seems like there is a bug in our implementation. It correctly errors when dimensionality matches but values differ. Sigh. Another thing to look into.

@Orthodox-64
Copy link
Contributor Author

@kgryte Thanks for the clarification. Understood — this appears to be a doctest linter issue and something we should look into. Appreciate the note.

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. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants