Skip to content

[SYCL][Doc]Editorial changes "if_architecture_is" #12258

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.

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

Merged
merged 2 commits into from
Jan 19, 2024

Conversation

gmlueck
Copy link
Contributor

@gmlueck gmlueck commented Dec 28, 2023

This commit makes some editorial changes to the "if_architecture_is" extension specification. None of the APIs changed, so this has no effect on the implementation. I'm making this in preparation for some new APIs that I will soon add to this extension.

  • Eliminate redundancy with the architecture enumeration. The code synopsis no longer duplicates the enumerators. These are now entirely defined in the table.

  • Add some missing entries to the table defining the enumerators, and fix some obvious cut-and-paste errors with the descriptions.

  • Update the function descriptions to our new format, using subsections Constraints, Preconditions, etc.

  • Use our new style where we make a line break after every sentence.

This commit makes some editorial changes to the "if_architecture_is"
extension specification.  None of the APIs changed, so this has no
effect on the implementation.  I'm making this in preparation for some
new APIs that I will soon add to this extension.

* Eliminate redundancy with the `architecture` enumeration.  The code
  synopsis no longer duplicates the enumerators.  These are now
  entirely defined in the table.

* Add some missing entries to the table defining the enumerators, and
  fix some obvious cut-and-paste errors with the descriptions.

* Update the function descriptions to our new format, using subsections
  `Constraints`, `Preconditions`, etc.

* User our new style where we make a line break after every sentence.
Copy link
Contributor

@Pennycook Pennycook left a comment

Choose a reason for hiding this comment

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

Two small and optional suggestions.

@gmlueck
Copy link
Contributor Author

gmlueck commented Jan 19, 2024

@intel/llvm-gatekeepers I think this PR is ready to merge.

@aelovikov-intel aelovikov-intel merged commit 7b62154 into intel:sycl Jan 19, 2024
@gmlueck gmlueck deleted the gmlueck/arch-editorial branch January 19, 2024 22:03
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.

3 participants