Skip to content

Address sphinx errors #1593

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
Merged
merged 8 commits into from
Mar 14, 2024
Merged

Address sphinx errors #1593

merged 8 commits into from
Mar 14, 2024

Conversation

oleksandr-pavlyk
Copy link
Contributor

Addressed indentation, and spacing errors tripping Sphinx, as guided by output of sphinx-build command.

The log of sphinx build should not contain non-blocking `ERROR statements in the build log/

  • 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?
  • Have you checked performance impact of proposed changes?
  • If this PR is a work in progress, are you opening the PR as a draft?

@oleksandr-pavlyk
Add new empty line to docstring of has_aspect_atomic64 property per s…
487ea2a 
…phinx error
@oleksandr-pavlyk
Add new empty line to docstring of USMAllocationError per sphinx error
def745e
@oleksandr-pavlyk
Change docstring of usm_ndarray per Sphinx errors
f5addb3
@oleksandr-pavlyk
tensordot docstring changes per Sphinx errors
babf58a 
Indentation fixed, new empty line added before enumeration
@oleksandr-pavlyk
Docstring edits per Sphinx errors
377fc9d 
Indentation fixes, new line added before enumeration,
added semicolons after item and start explanation sentence
indented on the next line
@oleksandr-pavlyk
Added new empty lines before enumeration per sphinx errors
397b4a9
@oleksandr-pavlyk
Add semicolon, and empty new line before enumeration
396f764 
This fixes Sphinx enumeration errors
@oleksandr-pavlyk
Address SPHINX error
f9a3e1b 
Docorated bash example as bash code-block, added URL for intel/pti-gpu,
mentioned `unitrace` as an alternative to `onetrace`.
@github-actions GitHub Actions
Copy link

github-actions bot commented Mar 14, 2024 •
edited
Loading

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

@coveralls
Copy link
Collaborator

Coverage Status

coverage: 87.832%. remained the same
when pulling f9a3e1b on address-sphinx-errors
into 4be843a on master.

@ndgrigorian
Copy link
Collaborator

@oleksandr-pavlyk
This resolves all of the non-blocking errors, but there are still a few warnings.
Screenshot 2024-03-14 132058

@github-actions GitHub Actions
Copy link

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_115 ran successfully.
Passed: 905
Failed: 1
Skipped: 94

@oleksandr-pavlyk
Copy link
Contributor Author

Yes, I am also encountering those warnings, but I'd like to defer resolving those to another PR.

ndgrigorian
ndgrigorian approved these changes Mar 14, 2024
View reviewed changes
Copy link
Collaborator

@ndgrigorian ndgrigorian left a comment

Choose a reason for hiding this comment

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

With warnings being deferred, this LGTM

@oleksandr-pavlyk oleksandr-pavlyk merged commit 80f4f30 into master Mar 14, 2024
@oleksandr-pavlyk oleksandr-pavlyk deleted the address-sphinx-errors branch March 14, 2024 21:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ndgrigorian ndgrigorian ndgrigorian approved these changes

@diptorupd diptorupd Awaiting requested review from diptorupd

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

Successfully merging this pull request may close these issues.
3 participants
@oleksandr-pavlyk @coveralls @ndgrigorian