Skip to content

Commit 0548fa8

Browse files
AntoinePrvtdegeus
authored andcommitted
Remove nonstandard single backticks from doc
1 parent 226e8dd commit 0548fa8

File tree

8 files changed

+9
-9
lines changed

8 files changed

+9
-9
lines changed

docs/source/api/xmath.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Mathematical functions
8585
+-------------------------------+------------------------------------------+
8686
| :cpp:func:`xt::greater_equal` | element-wise greater or equal |
8787
+-------------------------------+------------------------------------------+
88-
| :cpp:func:`xt::cast` | element-wise `static_cast` |
88+
| :cpp:func:`xt::cast` | element-wise ``static_cast`` |
8989
+-------------------------------+------------------------------------------+
9090
| :cpp:func:`xt::operator&` | bitwise and |
9191
+-------------------------------+------------------------------------------+

docs/source/closure-semantics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ The logic for this is encoded into xtensor's ``xclosure`` type trait.
104104
using xclosure_t = typename xclosure<E>::type;
105105
106106
In doing so, we ensure const-correctness, we avoid dangling reference, and ensure that lvalues remain lvalues.
107-
The `const_xclosure` follows the same scheme:
107+
The ``const_xclosure`` follows the same scheme:
108108

109109
.. code:: cpp
110110

docs/source/container.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ unsigned integers to the location of an element in the buffer. The range in whic
1616

1717
The scheme used to map indices into a location in the buffer is a strided indexing scheme. In such a scheme, the index
1818
``(i0, ..., in)`` corresponds to the offset ``sum(ik * sk)`` from the beginning of the one-dimensional buffer, where
19-
``(s0, ..., sn)`` are the `strides` of the array. Some particular cases of strided schemes implement well-known memory layouts:
19+
``(s0, ..., sn)`` are the ``strides`` of the array. Some particular cases of strided schemes implement well-known memory layouts:
2020

2121
- the row-major layout (or C layout) is a strided index scheme where the strides grow from right to left
2222
- the column-major layout (or Fortran layout) is a strided index scheme where the strides grow from left to right

docs/source/expression.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ For example, if ``A`` has shape ``(2, 3)``, and ``B`` has shape ``(4, 2, 3)``, t
102102
---------
103103
(4, 2, 3) # Result
104104
105-
The same rule holds for scalars, which are handled as 0-D expressions. If `A` is a scalar, the equation becomes:
105+
The same rule holds for scalars, which are handled as 0-D expressions. If ``A`` is a scalar, the equation becomes:
106106

107107
.. code:: none
108108

docs/source/getting_started.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ is:
5353
5454
g++ -I /path/to/xtensor/ -I /path/to/xtl/ example.cpp -o example
5555
56-
Note that if you installed *xtensor* and *xtl* with `cmake`, their headers will be located in the same
56+
Note that if you installed *xtensor* and *xtl* with *Cmake*, their headers will be located in the same
5757
directory, so you will need to provide only one path with the ``-I`` option.
5858

5959
When you run the program, it produces the following output:
@@ -65,7 +65,7 @@ When you run the program, it produces the following output:
6565
Building with cmake
6666
-------------------
6767

68-
A better alternative for building programs using *xtensor* is to use `cmake`, especially if you are
68+
A better alternative for building programs using *xtensor* is to use *Cmake*, especially if you are
6969
developing for several platforms. Assuming the following folder structure:
7070

7171
.. code:: bash

docs/source/missing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ same way as regular scalars.
5858
xt::xtensor<double, 1> b
5959
{ 1.0, 2.0 };
6060
61-
// `b` is broadcasted to match the shape of `a`
61+
// ``b`` is broadcasted to match the shape of ``a``
6262
std::cout << a + b << std::endl;
6363
6464
outputs:

docs/source/quickref/chunked_arrays.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ An in-memory chunked array has the following type:
4040
using inmemory_chunked_array = xt::xchunked_array<xarray<xarray<data_type>>>;
4141
4242
But you should not directly use this type to create a chunked array. Instead,
43-
use the `chunked_array` factory function:
43+
use the ``chunked_array`` factory function:
4444

4545
.. code::
4646

docs/source/view.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ The range function supports the placeholder ``_`` syntax:
7373
#include <xtensor/xarray.hpp>
7474
#include <xtensor/xview.hpp>
7575
76-
using namespace xt::placeholders; // required for `_` to work
76+
using namespace xt::placeholders; // required for ``_`` to work
7777
7878
auto a = xt::xarray<int>::from_shape({3, 2, 4});
7979
auto v1 = xt::view(a, xt::range(_, 2), xt::all(), xt::range(1, _));

0 commit comments

Comments
 (0)