boostorg / boostorg/compute

Improve documentation for system::default_device()

Open
#388 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
1.7k
Forks
340
PR merge metrics
No merged PRs in 30d

Description

Add better documentation for the `system::default_device()` method and indicate how it uses the environmental variables and what happens when no device is found.

From the review:

```
What does default_device do if there are no devices? Do the various
environment variables mentioned have any kind of precedence? (Probably
linking to the corresponding OpenCL docs is sufficient for such
questions). Do they have to be exact matches? Are they case-sensitive?
```
##

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.