Remove keyword arg descriptions for now

ITensor · Sep 5, 2023 · 80ada9c · 80ada9c
1 parent f8a9e1b
commit 80ada9c
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 10 deletions.
diff --git a/src/mps/mpo.jl b/src/mps/mpo.jl
@@ -532,13 +532,9 @@ function logdot(M1::MPO, M2::MPO; make_inds_match::Bool=false, kwargs...)
 end
 
 """
-    tr(M::MPO, kwargs...)
+    tr(M::MPO; kwargs...)
 
 Compute the trace of the MPO `M`.
-
-Optional keyword arguments:
-* `plev::Pair{Int,Int}=(0=>1)` - specify which Index prime levels are to be paired for taking the trace. The default is prime levels 0 and 1.
-* `tags::Pair=(ts""=>ts"")` - specify which Index tags to pair for taking the trace
 """
 function tr(M::MPO; plev::Pair{Int,Int}=0 => 1, tags::Pair=ts"" => ts"")
   N = length(M)

diff --git a/src/tensor_operations/matrix_algebra.jl b/src/tensor_operations/matrix_algebra.jl
@@ -14,16 +14,12 @@ function _tr(T::ITensor; plev::Pair{Int,Int}=0 => 1, tags::Pair=ts"" => ts"")
 end
 
 """
-    tr(T::ITensor, kwargs...)
+    tr(T::ITensor; kwargs...)
 
 Trace an ITensor over pairs of indices determined by
 the optional prime levels and tags passed as keyword arguments. 
 Indices that are not in pairs are not traced over, corresponding 
 to a "batched" trace.
-
-Optional keyword arguments:
-* `plev::Pair{Int,Int}=(0=>1)` - specify which Index prime levels are to be paired for taking the trace. The default is prime levels 0 and 1.
-* `tags::Pair=(ts""=>ts"")` - specify which Index tags to pair for taking the trace
 """
 function tr(T::ITensor; kwargs...)
   return _tr(T; kwargs...)