Skip to content

moved __cinit__ docstring into class docstrings #383

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

Merged
merged 1 commit into from
Apr 13, 2021
Merged

moved __cinit__ docstring into class docstrings #383

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions dpctl/_sycl_context.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,12 @@ cdef class _SyclContext:


cdef class SyclContext(_SyclContext):
""" Python wrapper class for cl::sycl::context.
""" Python class representing cl::sycl::context.

SyclContext() - create a context for a default device
SyclContext(filter_selector_string) - create a context for specified device
SyclContext(SyclDevice_instance) - create a context for the given device
SyclContext((dev1, dev2, ...)) - create a context for given set of device instances
"""

@staticmethod
Expand Down Expand Up @@ -176,11 +181,6 @@ cdef class SyclContext(_SyclContext):
return -128

def __cinit__(self, arg=None):
""" SyclContext() - create a context for a default device
SyclContext(filter_selector_string) - create a context for specified device
SyclContext(SyclDevice_instance) - create a context for the given device
SyclContext((dev1, dev2, ...)) - create a context for given set of devices
"""
cdef int ret = 0
if isinstance(arg, _SyclContext):
ret = self._init_context_from__SyclContext(<_SyclContext> arg)
Expand Down
5 changes: 4 additions & 1 deletion dpctl/_sycl_platform.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,10 @@ cdef class _SyclPlatform:


cdef class SyclPlatform(_SyclPlatform):
""" Python equivalent for cl::sycl::platform class.
""" Python class representing cl::sycl::platform class.

SyclPlatform() - create platform selected by sycl::default_selector
SyclPlatform(filter_selector) - create platform selected by filter selector
"""
@staticmethod
cdef void _init_helper(_SyclPlatform platform, DPCTLSyclPlatformRef PRef):
Expand Down
23 changes: 11 additions & 12 deletions dpctl/_sycl_queue.pyx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,20 +158,19 @@ cdef class _SyclQueue:


cdef class SyclQueue(_SyclQueue):
""" Python wrapper class for cl::sycl::queue.
""" Python class representing cl::sycl::queue.

SyclQueue(*, /, property=None)
create SyclQueue from default selector
SyclQueue(filter_string, *, /, propery=None)
create SyclQueue from filter selector string
SyclQueue(SyclDevice, *, /, property=None)
create SyclQueue from give SyclDevice automatically
finding/creating SyclContext.
SyclQueue(SyclContext, SyclDevice, *, /, property=None)
create SyclQueue from give SyclContext, SyclDevice
"""
def __cinit__(self, *args, **kwargs):
"""
SyclQueue(*, /, property=None)
create SyclQueue from default selector
SyclQueue(filter_string, *, /, propery=None)
create SyclQueue from filter selector string
SyclQueue(SyclDevice, *, /, property=None)
create SyclQueue from give SyclDevice automatically
finding/creating SyclContext.
SyclQueue(SyclContext, SyclDevice, *, /, property=None)
create SyclQueue from give SyclContext, SyclDevice
"""
cdef int len_args
cdef int status = 0
cdef const char *filter_c_str = NULL
Expand Down