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

Improve docstring for kernel_api functions. #1414

Merged
merged 1 commit into from
Mar 29, 2024
Merged

Improve docstring for kernel_api functions. #1414

merged 1 commit into from
Mar 29, 2024

Conversation

diptorupd
Copy link
Contributor

  • Have you provided a meaningful PR description?
    • Makes sure that summary fits on one line.
    • Add links to sycl specs
    • Adds some missing Args and Return tags to docstring.

@diptorupd diptorupd requested a review from ZzEeKkAa March 29, 2024 17:29
@github-actions GitHub Actions
Copy link
Contributor

Documentation preview: show.

ZzEeKkAa
ZzEeKkAa previously approved these changes Mar 29, 2024
View reviewed changes
Copy link
Contributor

@ZzEeKkAa ZzEeKkAa left a comment

Choose a reason for hiding this comment

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

LGTM! Thank you!

@ZzEeKkAa ZzEeKkAa enabled auto-merge March 29, 2024 17:42
@coveralls
Copy link
Collaborator

coveralls commented Mar 29, 2024 •
edited
Loading

Coverage Status

coverage: 84.81% (-0.009%) from 84.819%
when pulling c478b77 on docs/improve-doc-strings
into b6a13b0 on main.

@ZzEeKkAa ZzEeKkAa force-pushed the docs/improve-doc-strings branch from a0c5ad9 to 8f51804 Compare March 29, 2024 18:44
ZzEeKkAa
ZzEeKkAa previously approved these changes Mar 29, 2024
View reviewed changes
@diptorupd diptorupd force-pushed the docs/improve-doc-strings branch from 8f51804 to 68eae40 Compare March 29, 2024 18:54
Improve docstring for kernel_api functions.
c478b77 
    - Makes sure that summary fits on one line.
    - Add links to sycl specs
    - Adds some missing Args and Return tags to
      docstring.
@diptorupd diptorupd force-pushed the docs/improve-doc-strings branch from 68eae40 to c478b77 Compare March 29, 2024 18:56
@diptorupd diptorupd requested a review from ZzEeKkAa March 29, 2024 18:56
@ZzEeKkAa ZzEeKkAa merged commit af226f3 into main Mar 29, 2024
43 of 44 checks passed
@ZzEeKkAa ZzEeKkAa deleted the docs/improve-doc-strings branch March 29, 2024 19:32
@github-actions GitHub Actions
Copy link
Contributor

Documentation preview removed.

github-actions bot added a commit that referenced this pull request Mar 29, 2024
@github-actions
Merge pull request #1414 from IntelPython/docs/improve-doc-strings
eed7990 
Improve docstring for kernel_api functions. af226f3
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ZzEeKkAa ZzEeKkAa ZzEeKkAa 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.
3 participants
@diptorupd @coveralls @ZzEeKkAa