Skip to content

Commit

Permalink
DOC: Fix broken reference documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Ralph Urlus authored and Ralph Urlus committed Jun 8, 2021
1 parent e825341 commit be3a45a
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/basic_usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,8 @@ CARMA was designed with three patterns in mind: borrow, transfer ownership and v
Borrow
------

You can borrow the underlying memory of a Numpy array using the ``arr_to_*(py::array_t<T>, copy=false)``. The Armadillo object should not be returned without a copy out. Use this when you want to modify the memory in-place. If the array is not well behaved, see :doc:`Memory Management -- well behaved <well_behaved>`, the data is copied to a well-behaved memory and swapped in place of the input array. If ``copy=true`` is equivalent to the copy approach below.
You can borrow the underlying memory of a Numpy array using the ``arr_to_*(py::array_t<T>, copy=false)``. The Armadillo object should not be returned without a copy out. Use this when you want to modify the memory in-place.
If the array is not well behaved, see :ref:`Well behaved`, the data is copied to well-behaved memory and swapped in place of the input array. If ``copy=true`` is equivalent to the copy approach below.

.. note:: the size of the Armadillo object is not allowed change when you borrow.

Expand Down

0 comments on commit be3a45a

Please sign in to comment.