Skip to content

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

Merged
merged 1 commit into from
Mar 29, 2023

Conversation

oleksandr-pavlyk
Copy link
Contributor

Closes gh-1115 by adding Sphinx's annotations to use of usm_ndarray class to produce cross-references.

Also replaces out (usm_ndarray): with usm_ndarray: in Returns: section of docstrings. Changes are tailored to
the returned type, of course.

  • Have you provided a meaningful PR description?
  • Have you added a test, reproducer or referred to an issue with a reproducer?
  • Have you tested your changes locally for CPU and GPU devices?
  • Have you made sure that new changes do not introduce compiler warnings?
  • If this PR is a work in progress, are you filing the PR as a draft?

@github-actions
Copy link

@coveralls
Copy link
Collaborator

coveralls commented Mar 27, 2023

Coverage Status

Coverage: 82.802% (-0.03%) from 82.836% when pulling d0d4bf1 on doc-clean-up-fix-gh-1115 into ede58f6 on master.

@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_26 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_27 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

Arg:
shape (int, tuple):
Shape of the array to be created.
dtype (str, dtype):
Copy link
Collaborator

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.

Copy link
Contributor Author

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.

@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_28 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_32 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_33 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_34 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_37 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_38 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

@oleksandr-pavlyk oleksandr-pavlyk force-pushed the doc-clean-up-fix-gh-1115 branch from 3a595cd to d0d4bf1 Compare March 29, 2023 00:44
@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_31 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

@oleksandr-pavlyk
Copy link
Contributor Author

Thank you everybody for review. I have squashed all changes into one commit and intend to merge it shortly.

@oleksandr-pavlyk oleksandr-pavlyk merged commit 068f65c into master Mar 29, 2023
@oleksandr-pavlyk oleksandr-pavlyk deleted the doc-clean-up-fix-gh-1115 branch March 29, 2023 18:47
@github-actions
Copy link

Deleted rendered PR docs from intelpython.github.com/dpctl, latest should be updated shortly. 🤞

@github-actions
Copy link

Array API standard conformance tests for dpctl=0.14.3dev0=py310h76be34b_31 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tensor docs do not crosslink to other sections in dpctl site
5 participants