Skip to content

Commit ff0605b

Browse files
committed
Fix formatting and improve documentation clarity in various files
1 parent 9975597 commit ff0605b

5 files changed

Lines changed: 14 additions & 13 deletions

File tree

docs/source/api/xaccessible.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ Defined in ``xtensor/core/xaccessible.hpp``
1313
:members:
1414

1515
.. doxygenclass:: xt::xaccessible
16-
:members:
16+
:members:

docs/source/api/xfft.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ Defined in ``xtensor/misc/xfft.hpp``
1313

1414
.. doxygenfunction:: xt::fft::ifft(E&&, std::ptrdiff_t)
1515

16-
.. doxygenfunction:: xt::fft::convolve(E1&&, E2&&, std::ptrdiff_t)
16+
.. doxygenfunction:: xt::fft::convolve(E1&&, E2&&, std::ptrdiff_t)

include/xtensor/generators/xrandom.hpp

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -914,9 +914,10 @@ namespace xt
914914
*
915915
* For weighted random sampling with replacement, binary search with cumulative weights alogrithm is
916916
* used. For weighted random sampling without replacement, the algorithm used is the exponential sort
917-
* from [Efraimidis and Spirakis](https://linkinghub.elsevier.com/retrieve/pii/S002001900500298X) (2006) with the ``weight
918-
* / randexp(1)`` [trick](https://web.archive.org/web/20201021162211/https://krlmlr.github.io/wrswoR/)
919-
* from Kirill Müller.
917+
* from [Efraimidis and Spirakis](https://linkinghub.elsevier.com/retrieve/pii/S002001900500298X)
918+
* (2006) with the ``weight / randexp(1)``
919+
* [trick](https://web.archive.org/web/20201021162211/https://krlmlr.github.io/wrswoR/) from Kirill
920+
* Müller.
920921
*
921922
* Note: this function makes a copy of your data, and only 1D data is accepted.
922923
*

include/xtensor/misc/xmanipulation.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -659,7 +659,7 @@ namespace xt
659659
template <std::size_t N, class E>
660660
inline auto atleast_Nd(E&& e)
661661
{
662-
xstrided_slice_vector sv((std::max)(e.dimension(), N), all());
662+
xstrided_slice_vector sv((std::max) (e.dimension(), N), all());
663663
if (e.dimension() < N)
664664
{
665665
std::size_t i = 0;
@@ -1099,7 +1099,7 @@ namespace xt
10991099
* @param repeats The number of repetition of each elements.
11001100
* @p repeats is broadcasted to fit the shape of the given @p axis.
11011101
* @param axis the axis along which to repeat the value
1102-
* @return an expression with the same shape as ``e``, except along the given ``axis``
1102+
* @return an expression with the same shape as ``e``, except along the given ``axis``
11031103
*/
11041104
template <class E>
11051105
inline auto repeat(E&& e, std::size_t repeats, std::size_t axis)
@@ -1119,7 +1119,7 @@ namespace xt
11191119
* The size of @p repeats must match the shape of the given @p axis.
11201120
* @param axis the axis along which to repeat the value
11211121
*
1122-
* @return an expression with the same shape as ``e``, except along the given ``axis``
1122+
* @return an expression with the same shape as ``e``, except along the given ``axis``
11231123
*/
11241124
template <class E>
11251125
inline auto repeat(E&& e, const std::vector<std::size_t>& repeats, std::size_t axis)
@@ -1135,7 +1135,7 @@ namespace xt
11351135
* @param repeats The number of repetition of each elements.
11361136
* The size of @p repeats must match the shape of the given @p axis.
11371137
* @param axis the axis along which to repeat the value
1138-
* @return an expression with the same shape as ``e``, except along the given ``axis``
1138+
* @return an expression with the same shape as ``e``, except along the given ``axis``
11391139
*/
11401140
template <class E>
11411141
inline auto repeat(E&& e, std::vector<std::size_t>&& repeats, std::size_t axis)

include/xtensor/views/xindex_view.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -505,8 +505,8 @@ namespace xt
505505
/**
506506
* Returns a reference to the element at the specified position in the xindex_view.
507507
* @param first iterator starting the sequence of indices
508-
* @param last iterator ending the sequence of indices (not used, only for compatibility with xexpression operator())
509-
* The number of indices in the sequence should be equal to or greater 1.
508+
* @param last iterator ending the sequence of indices (not used, only for compatibility with xexpression
509+
* operator()) The number of indices in the sequence should be equal to or greater 1.
510510
*/
511511
template <class CT, class I>
512512
template <class It>
@@ -518,8 +518,8 @@ namespace xt
518518
/**
519519
* Returns a reference to the element at the specified position in the xindex_view.
520520
* @param first iterator starting the sequence of indices
521-
* @param last iterator ending the sequence of indices (not used, only for compatibility with xexpression operator())
522-
* The number of indices in the sequence should be equal to or greater 1.
521+
* @param last iterator ending the sequence of indices (not used, only for compatibility with xexpression
522+
* operator()) The number of indices in the sequence should be equal to or greater 1.
523523
*/
524524
template <class CT, class I>
525525
template <class It>

0 commit comments

Comments
 (0)