-
-
Notifications
You must be signed in to change notification settings - Fork 990
docs: improve doctests in complex/base/wrap-function
#8666
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
docs: improve doctests in complex/base/wrap-function
#8666
Conversation
Coverage Report
The above coverage report was generated for the changes in this PR. |
|
I noticed your PR description contains closing keywords ("Resolves", "Closes", or "Fixes") referencing a "Tracking Issue". Why this matters: Required action: Thank you for your contribution to the project! |
complex/base/wrap function
complex/base/wrap functioncomplex/base/wrap-function
lib/node_modules/@stdlib/complex/base/wrap-function/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/wrap-function/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/wrap-function/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
Signed-off-by: Athan <[email protected]>
lib/node_modules/@stdlib/complex/base/wrap-function/lib/index.js
Outdated
Show resolved
Hide resolved
Signed-off-by: Athan <[email protected]>
lib/node_modules/@stdlib/complex/base/wrap-function/lib/main.js
Outdated
Show resolved
Hide resolved
Signed-off-by: Athan <[email protected]>
kgryte
left a comment
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.
LGTM after clean-up
lib/node_modules/@stdlib/complex/base/wrap-function/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
Signed-off-by: Athan <[email protected]>
Resolves a part of #8641
Description
This pull request:
complex/base/wrap-functionpackage to use the compact complex instance doctest notation.realf/imagfwith concise doctest annotations such as<Complex64>[ 7.0, 0.0 ].realf,imagf) where they were only used to show decomposed values.Related Issues
This pull request has the following related issues:
(Replace the placeholder above with the relevant issue number if applicable.)
Questions
yes , in this example there is a whole function of realf and imagf so do i need to change it or not ?

Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
N/A
@stdlib-js/reviewers