Update device description to new format #601
Conversation
Update the section describing the `device` class to the new format.
| the [code]#create_sub_devices()# member function template. | ||
| The resulting SYCL [code]#devices# are considered sub devices, and it is valid | ||
| A device can be partitioned into multiple devices, by calling the | ||
| [code]#device::create_sub_devices# member function template. |
There was a problem hiding this comment.
should be code or api?
There was a problem hiding this comment.
[code] is correct. The reason is that there are three different definitions of create_sub_devices: one for "partition equally", one for "partition by counts", and one for "partition by affinity domain". We cannot use [api] here because the tooling wouldn't know which of these three definitions to use as the hyperlink target.
| @ Constructor @ Description | ||
| a@ | ||
| [source] | ||
| .[apititle]#Default constructor# |
There was a problem hiding this comment.
Just curious: is this leading . on purpose?
There was a problem hiding this comment.
Yes. The . Asciidoc syntax adds a title to the [source] block below.
There was a problem hiding this comment.
Thanks for the explanation. I have not read the AsciiDoctor documentation for quite a while...
|
WG approved to merge. |
Cherry pick KhronosGroup#601 from main (cherry picked from commit a9e6c92)
Update the section describing the
deviceclass to the new format.