Merge pull request #971 from IntelPython/corrected-use-of-non-templated-unwrap-in-comments

oleksandr-pavlyk · web-flow · commit fafa97953f70 · 2022-11-07T12:55:42.000-06:00
Fixed usage of unwrap in comment to templated one
diff --git a/libsyclinterface/include/dpctl_sycl_queue_interface.h b/libsyclinterface/include/dpctl_sycl_queue_interface.h
@@ -178,7 +178,7 @@ DPCTLQueue_GetDevice(__dpctl_keep const DPCTLSyclQueueRef QRef);
  * A wrapper over ``sycl::queue.submit()``. The function takes an
  * interoperability kernel, the kernel arguments, and a ``sycl::queue`` as
  * input. The kernel is submitted as
- * ``parallel_for(range<NRange>, *unwrap(KRef))``.
+ * ``parallel_for(range<NRange>, *unwrap<kernel>(KRef))``.
  *
  * \todo ``sycl::buffer`` arguments are not supported yet.
  * \todo Add support for id<Dims> WorkItemOffset
@@ -222,7 +222,8 @@ DPCTLQueue_SubmitRange(__dpctl_keep const DPCTLSyclKernelRef KRef,
  *
  * A wrapper over ``sycl::queue.submit()``. The function takes an
  * interoperability kernel, the kernel arguments, and a Sycl queue as input.
- * The kernel is submitted as ``parallel_for(nd_range<NRange>, *unwrap(KRef))``.
+ * The kernel is submitted as
+ * ``parallel_for(nd_range<NRange>, *unwrap<kernel>(KRef))``.
  *
  * \todo sycl::buffer arguments are not supported yet.
  * \todo Add support for id<Dims> WorkItemOffset

Original file line number	Diff line number	Diff line change
`@@ -178,7 +178,7 @@ DPCTLQueue_GetDevice(__dpctl_keep const DPCTLSyclQueueRef QRef);`
`178`	`178`	* A wrapper over ``sycl::queue.submit()``. The function takes an
`179`	`179`	* interoperability kernel, the kernel arguments, and a ``sycl::queue`` as
`180`	`180`	`* input. The kernel is submitted as`
`181`		- * ``parallel_for(range<NRange>, *unwrap(KRef))``.
	`181`	+ * ``parallel_for(range<NRange>, *unwrap<kernel>(KRef))``.
`182`	`182`	`*`
`183`	`183`	* \todo ``sycl::buffer`` arguments are not supported yet.
`184`	`184`	`* \todo Add support for id<Dims> WorkItemOffset`
`@@ -222,7 +222,8 @@ DPCTLQueue_SubmitRange(__dpctl_keep const DPCTLSyclKernelRef KRef,`
`222`	`222`	`*`
`223`	`223`	* A wrapper over ``sycl::queue.submit()``. The function takes an
`224`	`224`	`* interoperability kernel, the kernel arguments, and a Sycl queue as input.`
`225`		- * The kernel is submitted as ``parallel_for(nd_range<NRange>, *unwrap(KRef))``.
	`225`	`+ * The kernel is submitted as`
	`226`	+ * ``parallel_for(nd_range<NRange>, *unwrap<kernel>(KRef))``.
`226`	`227`	`*`
`227`	`228`	`* \todo sycl::buffer arguments are not supported yet.`
`228`	`229`	`* \todo Add support for id<Dims> WorkItemOffset`