docs: improve doctests for ndarray instances#9364
docs: improve doctests for ndarray instances#9364Venkat5599 wants to merge 3 commits intostdlib-js:developfrom
Conversation
There was a problem hiding this comment.
Copilot wasn't able to review any files in this pull request.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
👋 Hi there! 👋 And thank you for opening your first pull request! We will review it shortly. 🏃 💨 Getting Started
Next Steps
Running Tests LocallyYou can use # Run tests for all packages in the math namespace:
make test TESTS_FILTER=".*/@stdlib/math/.*"
# Run benchmarks for a specific package:
make benchmark BENCHMARKS_FILTER=".*/@stdlib/math/base/special/sin/.*"If you haven't heard back from us within two weeks, please ping us by tagging the "reviewers" team in a comment on this PR. If you have any further questions while waiting for a response, please join our Zulip community to chat with project maintainers and other community members. We appreciate your contribution! Documentation Links |
Coverage Report
The above coverage report was generated for the changes in this PR. |
ndarray/count-if
ndarray/count-if|
/stdlib merge |
|
Thank you for working on this pull request. However, we cannot accept your contribution as the issue this pull request seeks to resolve has already been addressed in a different pull request or commit. Thank you again for your interest in stdlib, and we look forward to reviewing your future contributions. |
Resolves #8850
Description
This pull request improves the JSDoc examples in the
ndarray/count-ifpackage by updating doctests to use the new ndarray instance notation format instead of explicit.get()method calls.Changes made:
lib/main.jsto use// returns <ndarray>[ 5 ]instead of calling.get()and separately showing the returned valueWhy this change?
This RFC seeks to leverage recent improvements in the doctest framework which now supports ndarray instance notation. This change makes documentation examples more concise and easier to understand.
Related Issues
This pull request implements improvements requested in:
array/base/bifurcate-indices-by#8850 - RFC: Improve doctests for ndarray instances in ndarrayQuestions
No questions for reviewers.
Other
This change follows the exact pattern established in commit 46d9a44 as referenced in the RFC. The modification is minimal, focused, and does not alter any functionality—only documentation clarity.
Checklist
AI Assistance
This PR was fully authored manually by myself without AI assistance.
@stdlib-js/reviewers