[doc] Minor documentation updates

Author: Thoemi09

c++/itertools/range.hpp

@@ -44,8 +44,8 @@ namespace itertools {
   /**
    * @brief A lazy range of integers that mimics a Python range.
    *
-   * @details It stores the first value, the last value (excluded) and the step size between two indices.
-   * By default, the step size is set to 1.
+   * @details It stores the first value, the last value (excluded) and the step size between two indices. By default,
+   * the step size is set to 1.
    *
    * This function returns an iterable lazy object, which can be used in range-based for loops:
    *
@@ -164,9 +164,9 @@ namespace itertools {
     [[nodiscard]] range operator+(long shift) const { return {first_ + shift, last_ + shift, step_}; }
 
     /**
-     * @brief Write the range details to std::ostream.
+     * @brief Write the range details to `std::ostream`.
      *
-     * @param os std::ostream object.
+     * @param os `std::ostream` object.
      * @param rg range object.
      * @return Reference to os.
      */

c++/itertools/utils.hpp

@@ -64,7 +64,7 @@ namespace itertools {
    *
    * @tparam R Range type.
    * @param rg Range.
-   * @return std::vector<T> containing the elements of the range, where T denotes the value type of the range.
+   * @return `std::vector<T>` containing the elements of the range, where T denotes the value type of the range.
    */
   template <typename R> [[nodiscard]] auto make_vector_from_range(R const &rg) {
     std::vector<std::decay_t<decltype(*(std::begin(rg)))>> vec{};
@@ -80,14 +80,15 @@ namespace itertools {
   /**
    * @brief Given an integer range `[first, last)`, divide it as equally as possible into N chunks.
    *
-   * @details It is intended to divide a range among different processes. If the size of the range is not
-   * divisible by N without a remainder, i.e. `r = (last - first) % N`, then the first `r` chunks have one more element.
+   * @details It is intended to divide a range among different processes. If the size of the range is not divisible by
+   * \f$ N \f$ without a remainder, i.e. `r = (last - first) % N`, then the first `r` chunks have one more element.
    *
    * @param first First value of the range.
    * @param last Last value of the range (excluded).
    * @param n_chunks Number of chunks to divide the range into.
    * @param rank Rank of the calling process.
-   * @return Pair of indices specifying the first and last (excluded) value of the chunk assigned to the calling process.
+   * @return Pair of indices specifying the first and last (excluded) value of the chunk assigned to the calling
+   * process.
    */
   [[nodiscard]] inline std::pair<std::ptrdiff_t, std::ptrdiff_t> chunk_range(std::ptrdiff_t first, std::ptrdiff_t last, long n_chunks, long rank) {
     auto total_size    = last - first;