-
-
Notifications
You must be signed in to change notification settings - Fork 987
docs: improve doctests for complex number instances in complex/base/cast-return
#8664
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 for complex number instances in complex/base/cast-return
#8664
Conversation
|
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:
This acknowledgment confirms that you've read the guidelines, which include:
We can't review or accept contributions without this acknowledgment. Thank you for your understanding and cooperation. We look forward to reviewing your contribution! |
Coverage Report
The above coverage report was generated for the changes in this PR. |
|
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:
This acknowledgment confirms that you've read the guidelines, which include:
We can't review or accept contributions without this acknowledgment. Thank you for your understanding and cooperation. We look forward to reviewing your contribution! |
|
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/cast-return
lib/node_modules/@stdlib/complex/base/cast-return/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/cast-return/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/cast-return/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/cast-return/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/cast-return/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/cast-return/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/cast-return/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/cast-return/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/cast-return/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
lib/node_modules/@stdlib/complex/base/cast-return/docs/types/index.d.ts
Outdated
Show resolved
Hide resolved
Signed-off-by: Athan <kgryte@gmail.com>
lib/node_modules/@stdlib/complex/base/cast-return/examples/index.js
Outdated
Show resolved
Hide resolved
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
Signed-off-by: Athan <kgryte@gmail.com>
lib/node_modules/@stdlib/complex/base/cast-return/examples/index.js
Outdated
Show resolved
Hide resolved
Signed-off-by: Athan <kgryte@gmail.com>
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 considerable clean-up.
@aryan7071 Please ensure you have read and followed our contributing guidelines. It is clear from a number of mistakes made in this PR that you have not properly setup your local dev env.
lib/node_modules/@stdlib/complex/base/cast-return/examples/index.js
Outdated
Show resolved
Hide resolved
Signed-off-by: Athan <kgryte@gmail.com>
|
Thank you for the feedback. I will review the contributing guidelines again and make sure my local dev env is set up correctly. I’ll follow the project’s conventions more closely in future contributions. Thank you for the guidance. |
Resolves a part of #8641
Description
This pull request:
complex/base/cast-returnpackage 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
No.
Other
No.
Checklist
AI Assistance
If you answered "yes" above, how did you use AI assistance?
Disclosure
N/A
@stdlib-js/reviewers