From 0548fa8ebba541c69c8897109aaabef1b16c471d Mon Sep 17 00:00:00 2001 From: AntoinePrv Date: Mon, 29 Nov 2021 14:53:57 -0500 Subject: [PATCH] Remove nonstandard single backticks from doc --- docs/source/api/xmath.rst | 2 +- docs/source/closure-semantics.rst | 2 +- docs/source/container.rst | 2 +- docs/source/expression.rst | 2 +- docs/source/getting_started.rst | 4 ++-- docs/source/missing.rst | 2 +- docs/source/quickref/chunked_arrays.rst | 2 +- docs/source/view.rst | 2 +- 8 files changed, 9 insertions(+), 9 deletions(-) diff --git a/docs/source/api/xmath.rst b/docs/source/api/xmath.rst index 7df6626f6..ac64bc619 100644 --- a/docs/source/api/xmath.rst +++ b/docs/source/api/xmath.rst @@ -85,7 +85,7 @@ Mathematical functions +-------------------------------+------------------------------------------+ | :cpp:func:`xt::greater_equal` | element-wise greater or equal | +-------------------------------+------------------------------------------+ - | :cpp:func:`xt::cast` | element-wise `static_cast` | + | :cpp:func:`xt::cast` | element-wise ``static_cast`` | +-------------------------------+------------------------------------------+ | :cpp:func:`xt::operator&` | bitwise and | +-------------------------------+------------------------------------------+ diff --git a/docs/source/closure-semantics.rst b/docs/source/closure-semantics.rst index 068537672..91dc73242 100644 --- a/docs/source/closure-semantics.rst +++ b/docs/source/closure-semantics.rst @@ -104,7 +104,7 @@ The logic for this is encoded into xtensor's ``xclosure`` type trait. using xclosure_t = typename xclosure::type; In doing so, we ensure const-correctness, we avoid dangling reference, and ensure that lvalues remain lvalues. -The `const_xclosure` follows the same scheme: +The ``const_xclosure`` follows the same scheme: .. code:: cpp diff --git a/docs/source/container.rst b/docs/source/container.rst index fc9799203..ee6434637 100644 --- a/docs/source/container.rst +++ b/docs/source/container.rst @@ -16,7 +16,7 @@ unsigned integers to the location of an element in the buffer. The range in whic The scheme used to map indices into a location in the buffer is a strided indexing scheme. In such a scheme, the index ``(i0, ..., in)`` corresponds to the offset ``sum(ik * sk)`` from the beginning of the one-dimensional buffer, where -``(s0, ..., sn)`` are the `strides` of the array. Some particular cases of strided schemes implement well-known memory layouts: +``(s0, ..., sn)`` are the ``strides`` of the array. Some particular cases of strided schemes implement well-known memory layouts: - the row-major layout (or C layout) is a strided index scheme where the strides grow from right to left - the column-major layout (or Fortran layout) is a strided index scheme where the strides grow from left to right diff --git a/docs/source/expression.rst b/docs/source/expression.rst index bd0f27cfa..71f80629c 100644 --- a/docs/source/expression.rst +++ b/docs/source/expression.rst @@ -102,7 +102,7 @@ For example, if ``A`` has shape ``(2, 3)``, and ``B`` has shape ``(4, 2, 3)``, t --------- (4, 2, 3) # Result -The same rule holds for scalars, which are handled as 0-D expressions. If `A` is a scalar, the equation becomes: +The same rule holds for scalars, which are handled as 0-D expressions. If ``A`` is a scalar, the equation becomes: .. code:: none diff --git a/docs/source/getting_started.rst b/docs/source/getting_started.rst index 8fdd0f4e7..0d9c2f4f5 100644 --- a/docs/source/getting_started.rst +++ b/docs/source/getting_started.rst @@ -53,7 +53,7 @@ is: g++ -I /path/to/xtensor/ -I /path/to/xtl/ example.cpp -o example -Note that if you installed *xtensor* and *xtl* with `cmake`, their headers will be located in the same +Note that if you installed *xtensor* and *xtl* with *Cmake*, their headers will be located in the same directory, so you will need to provide only one path with the ``-I`` option. When you run the program, it produces the following output: @@ -65,7 +65,7 @@ When you run the program, it produces the following output: Building with cmake ------------------- -A better alternative for building programs using *xtensor* is to use `cmake`, especially if you are +A better alternative for building programs using *xtensor* is to use *Cmake*, especially if you are developing for several platforms. Assuming the following folder structure: .. code:: bash diff --git a/docs/source/missing.rst b/docs/source/missing.rst index 1aea11bf4..80cba080c 100644 --- a/docs/source/missing.rst +++ b/docs/source/missing.rst @@ -58,7 +58,7 @@ same way as regular scalars. xt::xtensor b { 1.0, 2.0 }; - // `b` is broadcasted to match the shape of `a` + // ``b`` is broadcasted to match the shape of ``a`` std::cout << a + b << std::endl; outputs: diff --git a/docs/source/quickref/chunked_arrays.rst b/docs/source/quickref/chunked_arrays.rst index c7e0e9ebb..a04593409 100644 --- a/docs/source/quickref/chunked_arrays.rst +++ b/docs/source/quickref/chunked_arrays.rst @@ -40,7 +40,7 @@ An in-memory chunked array has the following type: using inmemory_chunked_array = xt::xchunked_array>>; But you should not directly use this type to create a chunked array. Instead, -use the `chunked_array` factory function: +use the ``chunked_array`` factory function: .. code:: diff --git a/docs/source/view.rst b/docs/source/view.rst index 8a2b11f5b..52f82009b 100644 --- a/docs/source/view.rst +++ b/docs/source/view.rst @@ -73,7 +73,7 @@ The range function supports the placeholder ``_`` syntax: #include #include - using namespace xt::placeholders; // required for `_` to work + using namespace xt::placeholders; // required for ``_`` to work auto a = xt::xarray::from_shape({3, 2, 4}); auto v1 = xt::view(a, xt::range(_, 2), xt::all(), xt::range(1, _));