Docstring edits only changes in documentation overhaul by oleksandr-pavlyk · Pull Request #1626 · IntelPython/dpctl

oleksandr-pavlyk · 2024-04-01T13:22:13Z

This PR is the part of gh-1619 that only modifies docstrings of Python functions, but does not change documentation itself, as requested by @diptorupd in gh-1619.

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?

github-actions · 2024-04-01T13:50:25Z

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

github-actions · 2024-04-01T13:56:48Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_182 ran successfully.
Passed: 839
Failed: 0
Skipped: 92

coveralls · 2024-04-01T14:01:10Z

coverage: 88.076% (+0.06%) from 88.021%
when pulling 5ed388c on docstring-edits-only
into a0c2aac on master.

github-actions · 2024-04-01T18:03:48Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_183 ran successfully.
Passed: 839
Failed: 0
Skipped: 92

github-actions · 2024-04-02T00:58:18Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_185 ran successfully.
Passed: 839
Failed: 0
Skipped: 92

github-actions · 2024-04-03T22:17:05Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_186 ran successfully.
Passed: 839
Failed: 0
Skipped: 92

github-actions · 2024-04-04T15:16:19Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_193 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

A new line was added after table of enumerations of supported dtype keyword values to make sphinx happy.

Added delimiters for positional/only, keyword/only, or positional-or-keyword arguments of array creation and elementwise functions. Modified implementation code and tests to specify arguments as keyword argument that had become keyword-only per array API specification.

…ctions to two line

…ctl.utils

Added two internal functions to __all__ list

@oleksandr-pavlyk

* Improves `tile` docstring * Improves `repeat` docstring * Fixed typos in `angle` and `reciprocal` docstrings * Fixed typos in docstrings for `permute_dims, `moveaxis`, and `swapaxes` * Fixes typo and grammar in `nonzero` docstring * Fixes a typo in `populate_params` in `blackscholes.pyx` example * Change to `broadcast-compatible` per PR review by @oleksandr-pavlyk

@ndgrigorian

This addresses issue pointed out by @ndgrigorian during PR review

oleksandr-pavlyk · 2024-04-04T15:39:11Z

This PR is now ready. Please review it. Any additional changes will go into a separate PR.

github-actions · 2024-04-04T15:55:11Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_193 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

Used property format to describe constructor arguments for MemoryUSM* objects. Corrected uses of escape quotes in docstrings. Populated docstring for __sycl_usm_array_interface__

github-actions · 2024-04-04T16:40:42Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_193 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

Corrects docstrings in `_accumulation.py` by adding documentation for `out` keyword to `cumulative_*` functions

github-actions · 2024-04-04T18:27:54Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_194 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

@vtavana

As pointed out by @vtavana

github-actions · 2024-04-04T20:51:35Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_195 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

`N-correction` becomes `N - correction` to avoid confusing subtraction with hyphenation

github-actions · 2024-04-04T22:45:40Z

Array API standard conformance tests for dpctl=0.17.0dev0=py310h15de555_198 ran successfully.
Passed: 869
Failed: 9
Skipped: 92

ndgrigorian

This LGTM now!

oleksandr-pavlyk changed the title ~~Docstring edits only~~ Docstring edits only changes in documentation overhaul Apr 1, 2024

oleksandr-pavlyk force-pushed the docstring-edits-only branch from 891a1c5 to 7ac9ff2 Compare April 1, 2024 17:25

oleksandr-pavlyk added 21 commits April 4, 2024 10:16

Docstring edit for intel_device_info function

e958420

Docstring edits for SyclContext

b817b94

Docstring edits for SyclDevice and exceptions

add054e

Docstring edits for device selection free functions

729dcb9

Docstring edits for SyclPlatform class and lsplatform function

4379848

Docstring edits for SyclQueue and exceptions

bd1f303

Docstring edits for SyclTimer class

699bb78

Docstring edit for docstring of usm_ndarray

4a6dd74

A new line was added after table of enumerations of supported dtype keyword values to make sphinx happy.

Docstring edits for tensor.can_cast function

a3691a2

Docstring edits, added pos/kw arg delimeters to signature for reductions

2c4c5a6

Added new line to keep separation between definitions of adjacent fun…

d8df301

…ctions to two line

Use position-only, keyword-only delimiters in definition of all/any

7e5be27

Fixed typo in API function in _usmarray

c87d31b

Insert positional/keyword arguments only delimites in signature of dp…

586a9df

…ctl.utils

Fixed typo in the example

7370c3f

Use positional/keyword only args delimiter in manipulation functions

5bb0fe8

Adjusted tests to fix violations of keyword-arg given as positional

19185bf

Added positional-only, keyword-only delimiters to fns from _copy_utils

8fed12b

Insert positional-only/keyword-only delimiters

63218b9

Added two internal functions to __all__ list

Fixed using keyword-only arg as positional in _linear_algebra_functions

0396c31

oleksandr-pavlyk and others added 4 commits April 4, 2024 10:16

Removed positional only delimiter in isdtype per array API test failure

3a7fa7f

Define defgroup MemorySemantics for memory semantics tokens

9a11287

Fix docstring of create_program_from_spirv

d9c0790

This addresses issue pointed out by @ndgrigorian during PR review

oleksandr-pavlyk force-pushed the docstring-edits-only branch from 43e7b4d to afb3172 Compare April 4, 2024 15:16

oleksandr-pavlyk requested a review from ndgrigorian April 4, 2024 15:29

Edited docstrings in _memory.pyx

93ce113

Used property format to describe constructor arguments for MemoryUSM* objects. Corrected uses of escape quotes in docstrings. Populated docstring for __sycl_usm_array_interface__

oleksandr-pavlyk force-pushed the docstring-edits-only branch from afb3172 to 93ce113 Compare April 4, 2024 16:02

Resolves gh-1634

c2c4072

Corrects docstrings in `_accumulation.py` by adding documentation for `out` keyword to `cumulative_*` functions

ndgrigorian added 2 commits April 4, 2024 13:14

Fix docstrings for sum, prod, logsumexp, and reduce_hypot

03e9fbd

As pointed out by @vtavana

Tweaks to docstrings in _set_functions

123092b

ndgrigorian added 2 commits April 4, 2024 14:51

Tweaks to docstrings for take and put

b810771

Tweaks to statistical function docstrings

5ed388c

`N-correction` becomes `N - correction` to avoid confusing subtraction with hyphenation

ndgrigorian approved these changes Apr 4, 2024

View reviewed changes

oleksandr-pavlyk merged commit ca59c3d into master Apr 5, 2024

oleksandr-pavlyk deleted the docstring-edits-only branch April 5, 2024 02:13

vtavana mentioned this pull request Apr 5, 2024

update dpctl function signature IntelPython/dpnp#1775

Merged

6 tasks

oleksandr-pavlyk mentioned this pull request Sep 16, 2024

Update CONTRIBUTION.md #141

Closed

2 tasks

Conversation

oleksandr-pavlyk commented Apr 1, 2024

Uh oh!

github-actions Bot commented Apr 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 1, 2024

Uh oh!

coveralls commented Apr 1, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Apr 1, 2024

Uh oh!

github-actions Bot commented Apr 2, 2024

Uh oh!

github-actions Bot commented Apr 3, 2024

Uh oh!

github-actions Bot commented Apr 4, 2024

Uh oh!

oleksandr-pavlyk commented Apr 4, 2024

Uh oh!

github-actions Bot commented Apr 4, 2024

Uh oh!

github-actions Bot commented Apr 4, 2024

Uh oh!

github-actions Bot commented Apr 4, 2024

Uh oh!

github-actions Bot commented Apr 4, 2024

Uh oh!

github-actions Bot commented Apr 4, 2024

Uh oh!

ndgrigorian left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions Bot commented Apr 1, 2024 •

edited

Loading

coveralls commented Apr 1, 2024 •

edited

Loading