Fix documentation warning when rendering `diff` docstring by ndgrigorian · Pull Request #1855 · IntelPython/dpctl · GitHub
Skip to content

Fix documentation warning when rendering diff docstring#1855

Merged
oleksandr-pavlyk merged 2 commits into
masterfrom
fix-diff-docstring
Oct 8, 2024
Merged

Fix documentation warning when rendering diff docstring#1855
oleksandr-pavlyk merged 2 commits into
masterfrom
fix-diff-docstring

Conversation

@ndgrigorian

@ndgrigorian ndgrigorian commented Oct 2, 2024 •
edited
Loading

Copy link
Copy Markdown
Collaborator

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?

@github-actions

github-actions Bot commented Oct 2, 2024 •
edited
Loading

Copy link
Copy Markdown

@github-actions

github-actions Bot commented Oct 2, 2024

Copy link
Copy Markdown

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

@github-actions

github-actions Bot commented Oct 2, 2024

Copy link
Copy Markdown

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

@coveralls

coveralls commented Oct 2, 2024 •
edited
Loading

Copy link
Copy Markdown
Collaborator

Coverage Status

coverage: 87.907%. remained the same
when pulling 82706e8 on fix-diff-docstring
into 7ae2a91 on master.

@oleksandr-pavlyk

oleksandr-pavlyk commented Oct 2, 2024

Copy link
Copy Markdown
Contributor

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'

oleksandr-pavlyk
oleksandr-pavlyk approved these changes Oct 8, 2024
View reviewed changes

@oleksandr-pavlyk oleksandr-pavlyk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Let's resolve the issue with unresolved 'broadcasting' label in a separate PR. Thank you @ndgrigorian

@oleksandr-pavlyk

oleksandr-pavlyk commented Oct 8, 2024

Copy link
Copy Markdown
Contributor

@ndgrigorian Could you please rebase your branch to pick up fix for the CI?

@ndgrigorian

ndgrigorian commented Oct 8, 2024

Copy link
Copy Markdown
Collaborator Author

@ndgrigorian Could you please rebase your branch to pick up fix for the CI?

It's been rebased

@github-actions

github-actions Bot commented Oct 8, 2024

Copy link
Copy Markdown

@oleksandr-pavlyk oleksandr-pavlyk merged commit d5de65b into master Oct 8, 2024
@oleksandr-pavlyk oleksandr-pavlyk deleted the fix-diff-docstring branch October 8, 2024 22:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer
@oleksandr-pavlyk oleksandr-pavlyk oleksandr-pavlyk approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Sphinx: unexpected indentation in docstring of diff

3 participants

@ndgrigorian @coveralls @oleksandr-pavlyk