Skip to content

Clarifications to backends section#194

Open
AerialMantis wants to merge 1 commit intoKhronosGroup:mainfrom
AerialMantis:fixes-to-backends-section
Open

Clarifications to backends section#194
AerialMantis wants to merge 1 commit intoKhronosGroup:mainfrom
AerialMantis:fixes-to-backends-section

Conversation

@AerialMantis
Copy link
Contributor

  • Remove wording which repeats "see ..." text to make it flow better.

* Remove wording which repeats "see ..." text to make it flow better.

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

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants