Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Add missing docstrings to SyclDevice properties #964

Merged
merged 2 commits into from
Nov 7, 2022
Merged

Add missing docstrings to SyclDevice properties #964

merged 2 commits into from
Nov 7, 2022

Conversation

diptorupd
Copy link
Contributor

@diptorupd diptorupd commented Nov 4, 2022 •
edited
Loading

Several properties of the SyclDevice class docstring do not include the Returns attribute and deprecation notices. The PR updates the docstrings for some of the SyclDevice properties needed to address #962

Closes #962

@github-actions
Copy link

github-actions bot commented Nov 4, 2022

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

@coveralls
Copy link
Collaborator

coveralls commented Nov 4, 2022 •
edited
Loading

Coverage Status

Coverage remained the same at 82.033% when pulling 91c1746 on docstrings/improve_docstrings into eb8ddb2 on master.

@github-actions
Copy link

github-actions bot commented Nov 4, 2022

Array API standard conformance tests for dpctl=0.14.0dev1=py310h8c27c75_3 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

@diptorupd diptorupd force-pushed the docstrings/improve_docstrings branch from 661970f to 2bd1432 Compare November 4, 2022 04:13
@diptorupd
Copy link
Contributor Author

@oleksandr-pavlyk I fixed few of the docstrings, but more such changes are needed. Also, for some reason the attribute list table is rendering weirdly for me.

@github-actions
Copy link

github-actions bot commented Nov 4, 2022

Array API standard conformance tests for dpctl=0.14.0dev1=py310h8c27c75_2 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

@oleksandr-pavlyk
Copy link
Collaborator

Thanks for cleaning this up @diptorupd . I left few comments.

@github-actions
Copy link

github-actions bot commented Nov 4, 2022

Array API standard conformance tests for dpctl=0.14.0dev1=py310h8c27c75_3 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

oleksandr-pavlyk
oleksandr-pavlyk approved these changes Nov 7, 2022
View reviewed changes
Copy link
Collaborator

@oleksandr-pavlyk oleksandr-pavlyk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! We will address the table formatting issue in a separate PR.

@oleksandr-pavlyk oleksandr-pavlyk merged commit 4e34b6d into master Nov 7, 2022
@oleksandr-pavlyk oleksandr-pavlyk deleted the docstrings/improve_docstrings branch November 7, 2022 18:55
@github-actions
Copy link

github-actions bot commented Nov 7, 2022

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

@github-actions
Copy link

github-actions bot commented Nov 7, 2022

Array API standard conformance tests for dpctl=0.14.0dev1=py310h8c27c75_26 ran successfully.
Passed: 33
Failed: 801
Skipped: 3138

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@oleksandr-pavlyk oleksandr-pavlyk oleksandr-pavlyk approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Suggested improvement to API docs
3 participants
@diptorupd @coveralls @oleksandr-pavlyk