Skip to content

Commit d7d7387

Browse files
authored
[DOCS] Fix QN Index docs regarding dir keyword argument (#1615)
1 parent 3fa632c commit d7d7387

File tree

2 files changed

+5
-6
lines changed

2 files changed

+5
-6
lines changed

Project.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "ITensors"
22
uuid = "9136182c-28ba-11e9-034c-db9fb085ebd5"
33
authors = ["Matthew Fishman <[email protected]>", "Miles Stoudenmire <[email protected]>"]
4-
version = "0.8.1"
4+
version = "0.8.2"
55

66
[deps]
77
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"

src/qn/qnindex.jl

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -139,25 +139,24 @@ function Index(qnblocks::QNBlocks; dir::Arrow=Out, tags="", plev=0)
139139
end
140140

141141
"""
142-
Index(qnblocks::Vector{Pair{QN, Int64}}, tags; dir::Arrow = Out,
143-
plev::Integer = 0)
142+
Index(qnblocks::Vector{Pair{QN, Int64}}, tags; plev::Integer = 0)
144143
145144
Construct a QN Index from a Vector of pairs of QN and block
146145
dimensions.
147146
148147
# Example
149148
150149
```
151-
Index([QN("Sz", -1) => 1, QN("Sz", 1) => 1], "i"; dir = In)
150+
i = Index([QN("Sz", -1) => 1, QN("Sz", 1) => 1], "i")
151+
idag = dag(i) # Same Index with arrow direction flipped
152152
```
153153
"""
154154
function Index(qnblocks::QNBlocks, tags; dir::Arrow=Out, plev::Integer=0)
155155
return Index(qnblocks; dir=dir, tags=tags, plev=plev)
156156
end
157157

158158
"""
159-
Index(qnblocks::Pair{QN, Int64}...; dir::Arrow = Out,
160-
tags = "",
159+
Index(qnblocks::Pair{QN, Int64}...; tags = "",
161160
plev::Integer = 0)
162161
163162
Construct a QN Index from a list of pairs of QN and block

0 commit comments

Comments
 (0)