Small edits for 2021.3 release (#231) (#233)

Updated date in conf.py, Updated list in extension api, Updated text in index, Changed variables to opensource content Signed-off-by: Dylan Benito <[email protected]> (cherry picked from commit 8e7814f) Co-authored-by: Dylan <[email protected]>
uxlfoundation · May 4, 2021 · e18b78a · e18b78a
1 parent be17200
commit e18b78a
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 22 deletions.
diff --git a/documentation/library_guide/conf.py b/documentation/library_guide/conf.py
@@ -138,7 +138,7 @@
 ditaxml_topic_meta["primaryOwner"]="Stern, Alexandra M ([email protected])"
 ditaxml_topic_meta["programidentifier"]="idz"
 ditaxml_topic_meta["programming language"]="guid:etm-e759606e77ad42549ba71c380d6d61e2"
-ditaxml_topic_meta["published date"]="04/28/2021"
+ditaxml_topic_meta["published date"]="05/03/2021"
 ditaxml_topic_meta["resourcetypeTag"]="guid:etm-15865f41343146919f486177b8dbb3f3"
 ditaxml_topic_meta["secondary contenttype"]="guid:etm-74fc3401b6764c42ad8255f4feb9bd9e"
 ditaxml_topic_meta["security classification"]="Public Content"

diff --git a/documentation/library_guide/extension_api.rst b/documentation/library_guide/extension_api.rst
@@ -246,10 +246,39 @@ to be called on both host and device.
 
 The following algorithms are available to use with the ranges:
 
-``all_of``, ``any_of``, ``copy``, ``count``, ``count_if``, ``equal``, ``exclusive_scan``, ``find``, ``find_if``, ``find_if_not``, ``find_end``,
-``find_first_of``, ``for_each``, ``inclusive_scan``, ``is_sorted``, ``is_sorted_until``, ``min_element``, ``max_element``, ``merge``,
-``minmax_element``, ``move``, ``reduce``, ``remove``, ``remove_if``, ``replace``, ``replace_if``, ``search``, ``sort``, ``stable_sort``,
-``transform``, ``transform_reduce``, ``transform_exclusive_scan``, ``transform_inclusive_scan``.
+* ``all_of``
+* ``any_of``
+* ``copy``
+* ``count``
+* ``count_if``
+* ``equal``
+* ``exclusive_scan``
+* ``find``
+* ``find_if``
+* ``find_if_not``
+* ``find_end``
+* ``find_first_of``
+* ``for_each``
+* ``inclusive_scan``
+* ``is_sorted``
+* ``is_sorted_until``
+* ``min_element``
+* ``max_element``
+* ``merge``
+* ``minmax_element``
+* ``move``
+* ``reduce``
+* ``remove``
+* ``remove_if``
+* ``replace``
+* ``replace_if``
+* ``search``
+* ``sort``
+* ``stable_sort``
+* ``transform``
+* ``transform_reduce``
+* ``transform_exclusive_scan``
+* ``transform_inclusive_scan``
 
 The signature example of the range-based algorithms looks like::
 
@@ -265,17 +294,17 @@ Use of the range-based API requires C++17 and the C++ standard libraries coming
 The following views are declared in the ``oneapi::dpl::experimental::ranges`` namespace. Only those are allowed to use as ranges
 for range-based algorithms.
 
-* ``all_view``: A custom utility - represents a view of all or a part of ``sycl::buffer`` underlying elements.
-* ``guard_view``: A custom utility - represents a view of USM data range defined by a two USM pointers.
-* ``iota_view``: A range factory - generates a sequence of N elements, which starts from an initial value and ends by final N-1.
-* ``generate``:  A range factory - generates a sequence of N elements, where each is produced by a given functional genrator.
-* ``fill``: A range factory - generates a sequence of N elements, where each is equal a given value.
-* ``zip_view``: A custom range adapter - produces one ``zip_view`` from other several views.
-* ``transform_view``: A range adapter - represents a view of a underlying sequence after applying a transformation to each element.
-* ``reverse_view``: A range adapter - produces a reversed sequence of elements provided by another view.
-* ``take_view``: A range adapter - produces a view of the first N elements from another view.
-* ``drop_view``: A range adapter - produces a view excluding the first N elements from another view.
-* ``rotate``: A range adapter - produces a left rotated sequence of elements provided by another view.
+* ``all_view`` is a custom utility that represents a view of all or a part of ``sycl::buffer`` underlying elements.
+* ``guard_view`` is a custom utility that represents a view of USM data range defined by a two USM pointers.
+* ``iota_view`` is a range factory that generates a sequence of N elements, which starts from an initial value and ends by final N-1.
+* ``generate`` is a range factory that generates a sequence of N elements, where each is produced by a given functional genrator.
+* ``fill`` is a range factory that generates a sequence of N elements, where each is equal a given value.
+* ``zip_view`` is a custom range adapter that produces one ``zip_view`` from other several views.
+* ``transform_view`` is a range adapter that represents a view of a underlying sequence after applying a transformation to each element.
+* ``reverse_view`` is a range adapter that produces a reversed sequence of elements provided by another view.
+* ``take_view`` is a range adapter that produces a view of the first N elements from another view.
+* ``drop_view`` is a range adapter that produces a view excluding the first N elements from another view.
+* ``rotate``: is a range adapter that produces a left rotated sequence of elements provided by another view.
 
 Example of Range-based API Usage
 --------------------------------
@@ -325,15 +354,15 @@ The behavior and signatures are overlapping with the C++17 STL algorithm with th
 
 The type of the future-like object returned from asynchronous algorithm is unspecified. The following member functions are present:
 
-* ``get()``: returns the result.
-* ``wait()``: wait for the result to become available.
+* ``get()`` returns the result.
+* ``wait()`` waits for the result to become available.
 
 If the returned object is the result of an algorithm with device policy, it can be converted into a ``sycl::event``.
 Lifetime of any resources the algorithm allocates (for example: temporary storage) is bound to the lifetime of the returned object.
 
 Utility functions:
 
-* ``wait_for_all(…)``: wait for an arbitrary number of objects that are convertible into ``sycl::event`` to become ready.
+* ``wait_for_all(…)`` waits for an arbitrary number of objects that are convertible into ``sycl::event`` to become ready.
 
 
 Example of Async API Usage

diff --git a/documentation/library_guide/index.rst b/documentation/library_guide/index.rst
@@ -3,7 +3,7 @@
 
 An introduction to |onedpl_short|.
 
-|onedpl_short| aims to work with the |dpcpp_cpp| to
+|onedpl_short| works with the |dpcpp_cpp| to
 provide high-productivity APIs to developers, which can minimize |dpcpp_long| programming
 efforts across devices for high performance parallel applications.
 |onedpl_short| contains an additional set of library classes and functions that are referred to throughout this document as Extension API.

diff --git a/documentation/library_guide/variables.txt b/documentation/library_guide/variables.txt
@@ -5,9 +5,9 @@
 .. |dpcpp_short| replace:: DPC++
 .. |hpc_tk| replace:: Intel® oneAPI HPC Toolkit (HPC Kit)
 .. |hpc_tk_short| replace:: HPC Kit
-.. |onedpl_long| replace:: Intel® oneAPI DPC++ Library (oneDPL)
+.. |onedpl_long| replace:: oneAPI DPC++ Library (oneDPL)
 .. |onedpl_short| replace:: oneDPL
-.. |onetbb_long| replace:: Intel® oneAPI Threading Building Blocks (oneTBB)
+.. |onetbb_long| replace:: oneAPI Threading Building Blocks (oneTBB)
 .. |onetbb_short| replace:: oneTBB
 .. |tbb_long| replace:: Intel® Threading Building Blocks (Intel® TBB)
 .. |tbb_short| replace:: Intel® TBB