Skip to content

Commit

Permalink
Remove nonstandard single backticks from doc
Browse files Browse the repository at this point in the history
  • Loading branch information
AntoinePrv authored and tdegeus committed Apr 7, 2022
1 parent 226e8dd commit 0548fa8
Show file tree
Hide file tree
Showing 8 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion docs/source/api/xmath.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 |
+-------------------------------+------------------------------------------+
Expand Down
2 changes: 1 addition & 1 deletion docs/source/closure-semantics.rst
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ The logic for this is encoded into xtensor's ``xclosure`` type trait.
using xclosure_t = typename xclosure<E>::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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/container.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/expression.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/source/missing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ same way as regular scalars.
xt::xtensor<double, 1> 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:
Expand Down
2 changes: 1 addition & 1 deletion docs/source/quickref/chunked_arrays.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ An in-memory chunked array has the following type:
using inmemory_chunked_array = xt::xchunked_array<xarray<xarray<data_type>>>;
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::
Expand Down
2 changes: 1 addition & 1 deletion docs/source/view.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ The range function supports the placeholder ``_`` syntax:
#include <xtensor/xarray.hpp>
#include <xtensor/xview.hpp>
using namespace xt::placeholders; // required for `_` to work
using namespace xt::placeholders; // required for ``_`` to work
auto a = xt::xarray<int>::from_shape({3, 2, 4});
auto v1 = xt::view(a, xt::range(_, 2), xt::all(), xt::range(1, _));
Expand Down

0 comments on commit 0548fa8

Please sign in to comment.