docs: improve doctests for complex number instances in `array/complex64`
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: na
- task: lint_package_json status: na
- task: lint_repl_help status: na
- task: lint_javascript_src status: passed
- task: lint_javascript_cli status: na
- task: lint_javascript_examples status: na
- 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
Resolves part of #8641
Description
This pull request updates documentation examples for array/complex64 to use complex number instance notation (e.g., <Complex64>[ 2.0, -2.0 ]) instead of decomposing values using realf and imagf, in accordance with the RFC guidance.
No functional code changes were made. Only documentation examples were updated.
Related Issues
- #8641
Questions
No.
Checklist
- [x] Read, understood, and followed the contributing guidelines.
AI Assistance
- [x] No
- [ ] Yes
Disclosure
N/A
@stdlib-js/reviewers
Coverage Report
| Package | Statements | Branches | Functions | Lines |
|---|---|---|---|---|
| array/complex64 | $\color{red}3087/3097$ $\color{green}+0.00%$ |
$\color{red}526/534$ $\color{green}+0.00%$ |
$\color{green}54/54$ $\color{green}+0.00%$ |
$\color{red}3087/3097$ $\color{green}+0.00%$ |
The above coverage report was generated for the changes in this PR.
:warning: Tracking Issue Closure Warning :warning:
I noticed your PR description contains closing keywords ("Resolves", "Closes", or "Fixes") referencing a "Tracking Issue".
Why this matters: Tracking issues should typically remain open until all related sub-issues are completed. GitHub automatically closes issues with such closing keywords when the PR is merged. For more information, see GitHub's documentation on using keywords in issues and pull requests.
Required action: Use "Progresses" instead to reference the tracking issue without automatically closing it.
Thank you for your contribution to the project!
i tried editing repl.txt but i was getting help REPL help lint error i am unable to fix it so i undo all the edit i done and remove all blank spaces after copying it from main stdlib
/stdlib merge
@aryan7071 You should not be doing z.re and z.im. That is not what is desired in https://github.com/stdlib-js/stdlib/issues/8641.
As for the REPL text lint error, that is likely because you did not branch from the latest develop. I have merged in the latest changes, so, if you pull down the latest changes in your branch, you should be able to update the REPL text file accordingly.