Skip to content

Commit

Permalink
Remove confusing wording about errors
Browse files Browse the repository at this point in the history
I noticed this while reviewing work on the SYCL reference guide.

The specification for the member functions `queue::get_context` and
`queue::get_device` implied that they could throw an exception for an
error scenario.  I cannot think of any reason these functions could
fail because a queue always has a context and a device.  Therefore,
I think we should remove these sentences.  For example, notice that
there is no similar wording for `queue::is_in_order`, which also has
no obvious reason to fail.
  • Loading branch information
gmlueck committed Oct 11, 2023
1 parent e63b8b7 commit ca9fd2b
Showing 1 changed file with 0 additions and 2 deletions.
2 changes: 0 additions & 2 deletions adoc/chapters/programming_interface.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3184,7 +3184,6 @@ a@
context get_context() const
----
a@ Returns the SYCL queue's context.
Reports errors using SYCL exception classes.
The value returned must be equal to that returned by [code]#get_info<info::queue::context>()#.

a@
Expand All @@ -3193,7 +3192,6 @@ a@
device get_device() const
----
a@ Returns the SYCL device the queue is associated with.
Reports errors using SYCL exception classes.
The value returned must be equal to that returned by [code]#get_info<info::queue::device>()#.

a@
Expand Down

0 comments on commit ca9fd2b

Please sign in to comment.