Skip to content

docs: improve doctests for ndarray instances in stats/maxsorted#9385

Merged
kgryte merged 2 commits into
stdlib-js:developfrom
shiavm006:docs/improve
Dec 26, 2025
Merged

docs: improve doctests for ndarray instances in stats/maxsorted#9385
kgryte merged 2 commits into
stdlib-js:developfrom
shiavm006:docs/improve

Conversation

@shiavm006

@shiavm006 shiavm006 commented Dec 26, 2025

Copy link
Copy Markdown
Contributor

Resolves a part of #9329 .

Description

  • Improves doctest annotations in the stats/maxsorted package by replacing verbose decomposition logic (using .get() method and ndarray2array() function) with the new concise ndarray instance notation <ndarray>[ ... ]
  • Updates all documentation examples in README.md, docs/types/index.d.ts, docs/repl.txt, and JSDoc examples in lib/*.js files
  • Removes unused ndarray2array imports from documentation examples
  • Follows the pattern established in reference commit 46d9a44

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

@stdlib-js/reviewers

@stdlib-bot

Copy link
Copy Markdown
Contributor

Hello! Thank you for your contribution to stdlib.

We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:

  1. Please read our contributing guidelines.

  2. Update your pull request description to include this checked box:

    - [x] Read, understood, and followed the [contributing guidelines](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md)

This acknowledgment confirms that you've read the guidelines, which include:

  • The developer's certificate of origin
  • Your agreement to license your contributions under the project's terms

We can't review or accept contributions without this acknowledgment.

Thank you for your understanding and cooperation. We look forward to reviewing your contribution!

@stdlib-bot stdlib-bot added Statistics Issue or pull request related to statistical functionality. First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue. Needs Review A pull request which needs code review. labels Dec 26, 2025
@stdlib-bot

stdlib-bot commented Dec 26, 2025

Copy link
Copy Markdown
Contributor

Coverage Report

Package Statements Branches Functions Lines
stats/maxsorted $\color{green}158/158$
$\color{green}+0.00%$
$\color{green}2/2$
$\color{green}+0.00%$
$\color{green}0/0$
$\color{green}+0.00%$
$\color{green}158/158$
$\color{green}+0.00%$

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

Comment thread lib/node_modules/@stdlib/stats/maxsorted/README.md Outdated
Comment thread lib/node_modules/@stdlib/stats/maxsorted/README.md Outdated
Signed-off-by: Athan <kgryte@gmail.com>

@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 removed the Needs Review A pull request which needs code review. label Dec 26, 2025
@shiavm006

Copy link
Copy Markdown
Contributor Author

LGTM

shouldnt i make the changes ?

@kgryte

kgryte commented Dec 26, 2025

Copy link
Copy Markdown
Member

@shiavm006 They've already been made. :)

@kgryte kgryte merged commit 7f51132 into stdlib-js:develop Dec 26, 2025
17 checks passed
@shiavm006

Copy link
Copy Markdown
Contributor Author

@shiavm006 They've already been made. :)

thanks i didnt checked them out sorry

@kgryte

kgryte commented Dec 26, 2025

Copy link
Copy Markdown
Member

Thank you for your contribution and congratulations on your first PR!

@shiavm006

Copy link
Copy Markdown
Contributor Author

Thank you for your contribution and congratulations on your first PR!

thanks

@shiavm006

Copy link
Copy Markdown
Contributor Author

Thank you for your contribution and congratulations on your first PR!

could u suggest me some more issues on which i can work on ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

First-time Contributor A pull request from a contributor who has never previously committed to the project repository. Good First PR A pull request resolving a Good First Issue. Statistics Issue or pull request related to statistical functionality.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants