Skip to content

Clarifications to backends section #194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AerialMantis wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Clarifications to backends section #194

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion source/backends.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ where backend_name is the associated identifier from ``backend``
in all upper-case.

For the name of the macro if the vendor defines the SYCL backend
outside of the Khronos SYCL group, see the following:
outside of the Khronos SYCL group.
Copy link
Contributor

@gmlueck gmlueck Apr 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not read well in the rendered HTML because it looks like a sentence fragment. Can we just remove the "seealso" callout and write the sentence like:

For the name of the macro if the vendor defines the SYCL backend outside of the Khronos SYCL group, see section 6 of the core SYCL specification.

Where "section 6" is a link to that section?

This would read well, and I think it's a general improvement. Section 6 does not apply generally to the "Backend macros" section of the reference guide, so the "seealso" callout is kind of confusing. By writing it as I suggest, it's clear that section 6 applies only to that one sentence.


.. seealso:: |SYCL_SPEC_EXTENSIONS|

Expand Down