KhronosGroup / KhronosGroup/SYCL_Reference

Error handling chapter desing

Open
#114 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
31
Forks
26
PR merge metrics
No merged PRs in 30d

Description

Currently, the "Error Handling" chapter looks like this:
![image](https://github.com/KhronosGroup/SYCL_Reference/assets/122783909/553d444b-7501-48bd-bf7a-d15731ba1336)

The proposed structure looks like this:

- Error handling
- Error handling rules ([4.13.1. Error handling rules](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#_error_handling_rules))
- Exceptions ([4.13.2. Exception class interface](https://registry.khronos.org/SYCL/specs/sycl-2020/html/sycl-2020.html#subsec:exception.class))

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 by comparing the current Error Handling chapter with the proposed structure in this issue and read the linked SYCL specification sections on error handling rules and exceptions. Done means the chapter reflects the proposed hierarchy and its content remains aligned with those referenced sections.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.