KhronosGroup / KhronosGroup/SYCL_Reference

sycl namespace

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

Description

The reference assumes `using namespace sycl;` in synopses and text.

@keryell suggested that instead namespaces should be explicit everywhere. Should we make them explicit in both the code snips and all the text within SYCL_Reference, or only in the code snips?

Currently we're mixing styles. For example:

![image](https://github.com/KhronosGroup/SYCL_Reference/assets/34314961/c52d24c1-226d-4650-9fb6-66582642b4b2)

![image](https://github.com/KhronosGroup/SYCL_Reference/assets/34314961/9aba5585-475f-46b6-bb38-67b7949fe0f1)

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the SYCL_Reference code snippets and surrounding text to inventory the mixed namespace styles shown in the issue. First resolve whether explicit namespaces apply to snippets only or to all prose, then update the affected reference content consistently; done means the chosen convention is applied throughout.

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
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.