Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document recursive (c)transpose #15795

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions base/docs/helpdb/Base.jl
Original file line number Diff line number Diff line change
Expand Up @@ -2629,7 +2629,9 @@ find(f, A)
"""
ctranspose(A)

The conjugate transposition operator (`'`).

The conjugate transposition operator (`'`). Operates recursively on arrays with vector or
matrix element type (e.g., block matrices).
"""
ctranspose

Expand Down Expand Up @@ -4726,7 +4728,9 @@ lock
"""
transpose(A)

The transposition operator (`.'`).
The transposition operator (`.'`). Operates recursively on arrays with vector or matrix
element type (e.g., block matrices). Non-recursive behavior may be obtained in such cases
by calling `permutedims(A, [2,1])`.
"""
transpose

Expand Down
4 changes: 2 additions & 2 deletions doc/stdlib/linalg.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1275,7 +1275,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f

.. Docstring generated from Julia source

The transposition operator (``.'``\ ).
The transposition operator (``.'``\ ). Operates recursively on arrays with vector or matrix element type (e.g., block matrices). Non-recursive behavior may be obtained in such cases by calling ``permutedims(A, [2,1])``\ .

.. function:: transpose!(dest,src)

Expand All @@ -1287,7 +1287,7 @@ Linear algebra functions in Julia are largely implemented by calling functions f

.. Docstring generated from Julia source

The conjugate transposition operator (``'``\ ).
The conjugate transposition operator (``'``\ ). Operates recursively on arrays with vector or matrix element type (e.g., block matrices).

.. function:: ctranspose!(dest,src)

Expand Down