Skip to content

[Docs] Remove dir kwarg from Index docstrings #1630

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 23, 2025
Merged

[Docs] Remove dir kwarg from Index docstrings #1630

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ITensors"
uuid = "9136182c-28ba-11e9-034c-db9fb085ebd5"
authors = ["Matthew Fishman <[email protected]>", "Miles Stoudenmire <[email protected]>"]
version = "0.8.3"
version = "0.8.4"

[deps]
Adapt = "79e6a3ab-5dfb-504d-930d-738a2a938a0e"
Expand Down
2 changes: 1 addition & 1 deletion src/index.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Create a copy of index `i` with identical `id`, `space`, `dir` and `tags`.
copy(i::Index) = Index(id(i), copy(space(i)), dir(i), tags(i), plev(i))

"""
sim(i::Index; tags = tags(i), plev = plev(i), dir = dir(i))
sim(i::Index; tags = tags(i), plev = plev(i))

Produces an `Index` with the same properties (dimension or QN structure)
but with a new `id`.
Expand Down
8 changes: 1 addition & 7 deletions src/qn/qnindex.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,17 +114,11 @@ function QuantumNumbers.have_same_mods(qnblocks::QNBlocks)
end

"""
Index(qnblocks::Vector{Pair{QN, Int64}}; dir::Arrow = Out,
tags = "",
plev::Integer = 0)
Index(qnblocks::Vector{Pair{QN, Int64}}; tags = "", plev::Integer = 0)

Construct a QN Index from a Vector of pairs of QN and block
dimensions.

Note: in the future, this may enforce that all blocks have the
same QNs (which would allow for some optimizations, for example
when constructing random QN ITensors).

# Example

```
Expand Down
Loading