KhronosGroup / KhronosGroup/SYCL_Reference
Stream chapter design
- Dominant language
- C++
- Stars
- 31
- Forks
- 26
- PR merge metrics
- No merged PRs in 30d
Description
Currently, the "IO" chapter looks like this:
We propose to rename this chapter to "Streams" or "IO streams" and implement the next structure:
- Streams
- ``sycl::stream`` ([4.16. Stream class](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#subsec:stream) except [Table 159](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#table.manipulators.stream))
- ``sycl::stream_manipulator`` ([Table 159](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#table.manipulators.stream) and all relevant information)
PR with updates will be created soon. Feel free to comment if you have any suggestions on the structure.
Contributor guide
No contributing guide indexed for this repository
Research direction
Start from the current “IO” chapter shown in the issue and compare its organization with the linked SYCL stream specification sections. Rename it to “Streams” or “IO streams,” then organize the material into sycl::stream and sycl::stream_manipulator sections, with the listed table excluded from the former and included in the latter.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100