Skip to content
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

Fix title and minor typos in documentation #6555

Merged
merged 1 commit into from
Nov 2, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 4 additions & 2 deletions docs/sphinx/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@
Distributed under the Boost Software License, Version 1.0. (See accompanying
file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

===================================
===================
|hpx| documentation
===================

Welcome to the |hpx| documentation!
===================================

If you're new to |hpx| you can get started with the :ref:`quickstart` guide.
Don't forget to read the :ref:`terminology` section to learn about the most
Expand Down
10 changes: 5 additions & 5 deletions docs/sphinx/manual/migration_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -200,7 +200,7 @@ Reduction
});


The reduction clause specifies that the variable `s`` should be reduced across iterations using the `plus<>`` operation.
The reduction clause specifies that the variable `s` should be reduced across iterations using the `plus<>` operation.
It initializes `s` to `0` at the beginning of the loop and accumulates the values of `s` from each iteration using the
`+` operator. The lambda function representing the loop body takes two parameters: `i`, which represents the loop index,
and `accum`, which is the reduction variable `s`. The lambda function is executed for each iteration of the loop.
Expand Down Expand Up @@ -649,7 +649,7 @@ its execution, you can simply remove the `wait()` function.
// synchronization: wait for both sections to complete
hpx::wait_all(future_section1, future_section2);

Unlike tasks, there is an implicit synchronization barrier at the end of each `sections``
Unlike tasks, there is an implicit synchronization barrier at the end of each `sections`
directive in |openmp|. This synchronization is achieved using :cpp:func:`hpx::wait_all` function.

.. note::
Expand Down Expand Up @@ -727,8 +727,8 @@ parallel_for_each
// loop body
});

By utilizing :cpp:func:`hpx::for_each`` and specifying a parallel execution policy with
`hpx::execution::par`, it is possible to transform `tbb::parallel_for_each`` into its
By utilizing :cpp:func:`hpx::for_each` and specifying a parallel execution policy with
`hpx::execution::par`, it is possible to transform `tbb::parallel_for_each` into its
equivalent counterpart in |hpx|.

parallel_invoke
Expand Down Expand Up @@ -881,7 +881,7 @@ Reduction
hpx::execution::par, values.begin(), values.end(), 0, std::plus{});

By utilizing :cpp:func:`hpx::reduce` and specifying a parallel execution policy with
`hpx::execution::par`, it is possible to transform `tbb::parallel_reduce`` into its
`hpx::execution::par`, it is possible to transform `tbb::parallel_reduce` into its
equivalent counterpart in |hpx|. As demonstrated in the previous example, the management
of intermediate results is seamlessly handled internally by |hpx|, eliminating the need
for explicit consideration.
Expand Down
Loading