KhronosGroup / KhronosGroup/SYCL-Docs
Usage of "Enumeration" in codeblock
- Dominant language
- JavaScript
- Stars
- 158
- Forks
- 80
- Avg merge
- 7d 6h
- Merged PRs (30d)
- 5
Description
Our code block, shoud be as maximun C++.
Good: https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#_special_member_functions (the `(1)` have been commented out)
```
specialization_id(const specialization_id& rhs) = delete; // (1)
specialization_id(specialization_id&& rhs) = delete; // (2)
specialization_id& operator=(const specialization_id& rhs) = delete; // (3)
specialization_id& operator=(specialization_id&& rhs) = delete; // (4)
```
Bad
```
template __writeable_swizzle__ swizzle() const (1)
__writeable_swizzle__ XYZW_ACCESS() const (2)
__writeable_swizzle__ RGBA_ACCESS() const (3)
__writeable_swizzle__ INDEX_ACCESS() const (4)
```
This will allow us to clang-format them.
I can make a PR, if we agree that it seem to be a good idea
Contributor guide
No contributing guide indexed for this repository
Research direction
Start by locating the specification code blocks that match the issue's good and bad examples, including the linked Special Member Functions section. Check which blocks should be marked as C++ so clang-format can process them, then verify the rendered documentation and formatting of the affected examples.】【。
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100