-
-
Notifications
You must be signed in to change notification settings - Fork 1k
docs: improve doctests for ndarray instances in ndarray/some-by
#9410
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: develop
Are you sure you want to change the base?
docs: improve doctests for ndarray instances in ndarray/some-by
#9410
Conversation
---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
- task: lint_filenames
status: passed
- task: lint_editorconfig
status: passed
- task: lint_markdown
status: passed
- task: lint_package_json
status: na
- task: lint_repl_help
status: passed
- task: lint_javascript_src
status: passed
- task: lint_javascript_cli
status: na
- task: lint_javascript_examples
status: passed
- task: lint_javascript_tests
status: na
- task: lint_javascript_benchmarks
status: na
- task: lint_python
status: na
- task: lint_r
status: na
- task: lint_c_src
status: na
- task: lint_c_examples
status: na
- task: lint_c_benchmarks
status: na
- task: lint_c_tests_fixtures
status: na
- task: lint_shell
status: na
- task: lint_typescript_declarations
status: passed
- task: lint_typescript_tests
status: passed
- task: lint_license_headers
status: passed
---
|
Hello! 👋 We've noticed that you've been opening a number of PRs addressing good first issues. Thank you for your interest and enthusiasm! Now that you've made a few contributions, we suggest no longer working on good first issues. Instead, we encourage you to prioritize cleaning up any PRs which have yet to be merged and then proceed to work on more involved tasks. Not only does this ensure that other new contributors can work on things and get ramped up on all things stdlib, it also ensures that you can spend your time on more challenging problems. 🚀 For ideas for future PRs, feel free to search the codebase for TODOs and FIXMEs and be sure to check out other open issues on the issue tracker. Cheers! |
Coverage Report
The above coverage report was generated for the changes in this PR. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the PR! I don’t think we need to update anything in index.js here, right @kgryte ?
|
|
||
| // Perform reduction: | ||
| var out = someBy.assign( x, 2, y, predicate ); | ||
| // returns <ndarray> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
include [ true ] here
|
|
||
| // Perform reduction: | ||
| var out = someBy.assign( x, 2, y, opts, predicate ); | ||
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
return is missing here
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes. report:
Progresses #9329.
Description
This pull request updates documentation examples in the
@stdlib/ndarray/some-bypackage to improve doctests for ndarray instances, in accordance with the RFC guidance.Specifically, this PR:
<ndarray>[ ... ])These updates improve clarity, consistency, and alignment with recent doctest framework capabilities.
Related Issues
Questions
No.
Other
No additional information.
Checklist
AI Assistance
@stdlib-js/reviewers