Closes gh-1114 and gh-1116

[oleksandr-pavlyk]

Closes gh-1114 and closes gh-1116.

A pass through doc-strings of dpctl.tensor functions and classes to improve rendering of the documentation and to expand docstring.

• 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]

View rendered docs @ https://intelpython.github.io/dpctl/pulls/1123/index.html

[coveralls]

Coverage: 82.45% (+0.02%) from 82.427% when pulling 49c3a9c on tensor-docs-cleanup into 8f828f2 on master.

[github-actions]

Array API standard conformance tests for dpctl=0.14.2=py310h76be34b_41 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

[github-actions]

Array API standard conformance tests for dpctl=0.14.2=py310h76be34b_42 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

[ndgrigorian]

@oleksandr-pavlyk
Documentation for place doesn't seem to be rendering correctly. It cuts off after the first parameter.
validate_usm_type summary renders as "[FIXME]: <class ‘builtin_function_or_method’> has a docstring with no summary"

[diptorupd]

@oleksandr-pavlyk Found few left over issues: reshape, from_dlpack still have the -> in the summary.

[diptorupd]

@oleksandr-pavlyk Found few left over issues: reshape, from_dlpack still have the -> in the summary.

It is a Sphinx issue IMO. The header of the detail section looks so much better with the -> and it even auto links to the usm_ndarray doc. The summary is butchered up.

[diptorupd]

@oleksandr-pavlyk Can you please check the following function in our generate_rst.py:

dpctl/docs/generate_rst.py

Line 378 in 8f828f2

def _get_doc_summary(obj):

Maybe we need to fix the logic here and the -> do not need to be removed from the signature in the docstring. Having the arrows generates much better detailed sections, and the butchered summary is in fact our doing.

[github-actions]

Array API standard conformance tests for dpctl=0.14.2=py310h76be34b_44 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

[github-actions]

Array API standard conformance tests for dpctl=0.14.2=py310h76be34b_45 ran successfully.
Passed: 46
Failed: 788
Skipped: 280

[oleksandr-pavlyk]

@oleksandr-pavlyk Can you please check the following function in our generate_rst.py:

dpctl/docs/generate_rst.py

Line 378 in 8f828f2

def _get_doc_summary(obj):

Maybe we need to fix the logic here and the -> do not need to be removed from the signature in the docstring. Having the arrows generates much better detailed sections, and the butchered summary is in fact our doing.

I think we should be using Python's typing support in dpctl.tensor functions for IDE to pick up arrows and more details.
It does not belong to the docstrings.

[github-actions]

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

[github-actions]

Array API standard conformance tests for dpctl=0.14.2=py310h76be34b_45 ran successfully.
Passed: 46
Failed: 788
Skipped: 280