-
Notifications
You must be signed in to change notification settings - Fork 30
Closes gh-1115, fixes docstring's Returns sections #1140
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
Conversation
View rendered docs @ https://intelpython.github.io/dpctl/pulls/1140/index.html |
Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_26 ran successfully. |
Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_27 ran successfully. |
Arg: | ||
shape (int, tuple): | ||
Shape of the array to be created. | ||
dtype (str, dtype): |
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.
For the sake of readability, it may be a good idea to either list all of the dtypes here as bullet points, or to have a page for our supported dtypes elsewhere, then redirect. The current format is a bit wordy and hard to read.
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.
Yes, great suggestion. I will add a skeleton of User guide pages and make sure to include the one about supported data types. Once there, we could refer to it from docstring.
Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_28 ran successfully. |
Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_32 ran successfully. |
Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_33 ran successfully. |
Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_34 ran successfully. |
Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_37 ran successfully. |
Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_38 ran successfully. |
3a595cd
to
d0d4bf1
Compare
Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_31 ran successfully. |
Thank you everybody for review. I have squashed all changes into one commit and intend to merge it shortly. |
Deleted rendered PR docs from intelpython.github.com/dpctl, latest should be updated shortly. 🤞 |
Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_31 ran successfully. |
Closes gh-1115 by adding Sphinx's annotations to use of
usm_ndarray
class to produce cross-references.Also replaces
out (usm_ndarray):
withusm_ndarray:
inReturns:
section of docstrings. Changes are tailored tothe returned type, of course.