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.

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

Fix documentation warning when rendering diff docstring #1855

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

ndgrigorian
Copy link
Collaborator

@ndgrigorian ndgrigorian commented Oct 2, 2024

This PR fixes a warning caused by the docstring for diff incorrectly indenting the description of the output shape.

Closes #1849

  • 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?
  • Have you added documentation for your changes, if necessary?
  • Have you added your changes to the changelog?
  • If this PR is a work in progress, are you opening the PR as a draft?

Copy link

github-actions bot commented Oct 2, 2024

Copy link

github-actions bot commented Oct 2, 2024

Array API standard conformance tests for dpctl=0.19.0dev0=py310hdf72452_109 ran successfully.
Passed: 895
Failed: 0
Skipped: 119

Copy link

github-actions bot commented Oct 2, 2024

Array API standard conformance tests for dpctl=0.19.0dev0=py310hdf72452_110 ran successfully.
Passed: 895
Failed: 0
Skipped: 119

@coveralls
Copy link
Collaborator

coveralls commented Oct 2, 2024

Coverage Status

coverage: 87.907%. remained the same
when pulling c8de265 on fix-diff-docstring
into f0f7837 on master.

@oleksandr-pavlyk
Copy link
Collaborator

The reported sphinx errors are gone indeed. One outstanding issue is

/home/runner/work/dpctl/dpctl/dpctl/tensor/_indexing_functions.py:docstring of dpctl.tensor._indexing_functions.take_along_axis:24: WARNING: undefined label: 'broadcasting'

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.

Sphinx: unexpected indentation in docstring of diff
3 participants