remove YaoBlocks from docstring

QuantumBFS · Aug 27, 2019 · 79e2bb8 · 79e2bb8
1 parent 551a458
commit 79e2bb8
Show file tree

Hide file tree

Showing 7 changed files with 30 additions and 30 deletions.
diff --git a/.gitignore b/.gitignore
@@ -8,3 +8,4 @@ docs/build/
 docs/site/
 docs/src/examples/*.md
 *.swp
+docs/Manifest.toml
diff --git a/Project.toml b/Project.toml
@@ -13,7 +13,7 @@ TupleTools = "9d95972d-f1c8-5527-a6e0-b4b365fa01f6"
 YaoBase = "a8f54c17-34bc-5a9d-b050-f522fe3f755f"
 
 [compat]
-BitBasis = "^0.5.0"
+BitBasis = "^0.6.0"
 LuxurySparse = "~0.4.0"
 YaoBase = "~0.11.0"
 julia = "^1.0.0"

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -3,4 +3,3 @@ BitBasis = "50ba71b6-fa0f-514d-ae9a-0916efc90dcf"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 YaoArrayRegister = "e600142f-9330-5003-8abb-0ebd767abc51"
 YaoBase = "a8f54c17-34bc-5a9d-b050-f522fe3f755f"
-YaoBlocks = "418bc28f-b43b-5e0b-a6e7-61bbc1a2c1df"
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,5 +1,5 @@
 using Documenter
-using YaoArrayRegister, YaoBase, YaoBlocks
+using YaoArrayRegister, YaoBase
 
 makedocs(
     modules = [YaoArrayRegister],

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,5 +1,5 @@
 ```@meta
 DocTestSetup = quote
-    using YaoBase, YaoBlocks, YaoArrayRegister
+    using YaoBase, YaoArrayRegister
 end
-```
+```
diff --git a/src/focus.jl b/src/focus.jl
@@ -13,8 +13,8 @@ new merged shape and order.
 
 # Example
 
-```jldoctest
-julia> YaoArrayRegister.contiguous_shape_order((2, 3, 4), (1, 2, 3))
+```jldoctest; setup=:(using YaoArrayRegister)
+julia> YaoArrayRegister.contiguous_shape_orders((2, 3, 4), (1, 2, 3))
 ([24], [1])
 ```
 """

diff --git a/src/register.jl b/src/register.jl
@@ -105,13 +105,13 @@ For bit string literal please read [`@bit_str`](@ref).
 
 # Examples
 
-```jldoctest
+```jldoctest; setup=:(using YaoArrayRegister)
 julia> ArrayReg(bit"1010")
-ArrayReg{1,Complex{Float64},Array...}
+ArrayReg{1, Complex{Float64}, Array...}
     active qubits: 4/4
 
 julia> ArrayReg(ComplexF32, bit"1010")
-ArrayReg{1,Complex{Float32},Array...}
+ArrayReg{1, Complex{Float32}, Array...}
     active qubits: 4/4
 ```
 """
@@ -289,13 +289,13 @@ defined with [`@bit_str`](@ref). See also [`zero_state`](@ref),
 
 # Examples
 
-```jldoctest
+```jldoctest; setup=:(using YaoArrayRegister)
 julia> product_state(bit"100"; nbatch=2)
-ArrayReg{2,Complex{Float64},Array...}
+ArrayReg{2, Complex{Float64}, Array...}
     active qubits: 3/3
 
 julia> product_state(ComplexF32, bit"101"; nbatch=2)
-ArrayReg{2,Complex{Float32},Array...}
+ArrayReg{2, Complex{Float32}, Array...}
     active qubits: 3/3
 ```
 """
@@ -309,17 +309,17 @@ See also [`zero_state`](@ref), [`rand_state`](@ref), [`uniform_state`](@ref).
 
 # Examples
 
-```jldoctest
+```jldoctest; setup=:(using YaoArrayRegister)
 julia> product_state(4, 3; nbatch=2)
-ArrayReg{2,Complex{Float64},Array...}
+ArrayReg{2, Complex{Float64}, Array...}
     active qubits: 4/4
 
 julia> product_state(4, 0b1001; nbatch=2)
-ArrayReg{2,Complex{Float64},Array...}
+ArrayReg{2, Complex{Float64}, Array...}
     active qubits: 4/4
 
 julia> product_state(ComplexF32, 4, 0b101)
-ArrayReg{1,Complex{Float32},Array...}
+ArrayReg{1, Complex{Float32}, Array...}
     active qubits: 4/4
 ```
 
@@ -344,17 +344,17 @@ See also [`product_state`](@ref), [`rand_state`](@ref), [`uniform_state`](@ref).
 
 # Examples
 
-```jldoctest
+```jldoctest; setup=:(using YaoArrayRegister)
 julia> zero_state(4)
-ArrayReg{1,Complex{Float64},Array...}
+ArrayReg{1, Complex{Float64}, Array...}
     active qubits: 4/4
 
 julia> zero_state(ComplexF32, 4)
-ArrayReg{1,Complex{Float32},Array...}
+ArrayReg{1, Complex{Float32}, Array...}
     active qubits: 4/4
 
 julia> zero_state(ComplexF32, 4; nbatch=3)
-ArrayReg{3,Complex{Float32},Array...}
+ArrayReg{3, Complex{Float32}, Array...}
     active qubits: 4/4
 ```
 """
@@ -369,17 +369,17 @@ Create a random [`ArrayReg`](@ref) with total number of qubits `n`.
 
 # Examples
 
-```jldoctest
+```jldoctest; setup=:(using YaoArrayRegister)
 julia> rand_state(4)
-ArrayReg{1,Complex{Float64},Array...}
+ArrayReg{1, Complex{Float64}, Array...}
     active qubits: 4/4
 
 julia> rand_state(ComplexF64, 4)
-ArrayReg{1,Complex{Float64},Array...}
+ArrayReg{1, Complex{Float64}, Array...}
     active qubits: 4/4
 
 julia> rand_state(ComplexF64, 4; nbatch=2)
-ArrayReg{2,Complex{Float64},Array...}
+ArrayReg{2, Complex{Float64}, Array...}
     active qubits: 4/4
 ```
 """
@@ -398,13 +398,13 @@ can also be created by applying [`H`](@ref) (Hadmard gate) on ``|00⋯00⟩`` st
 
 # Example
 
-```jldoctest
+```jldoctest; setup=:(using YaoArrayRegister)
 julia> uniform_state(4; nbatch=2)
-ArrayReg{2,Complex{Float64},Array...}
+ArrayReg{2, Complex{Float64}, Array...}
     active qubits: 4/4
 
 julia> uniform_state(ComplexF32, 4; nbatch=2)
-ArrayReg{2,Complex{Float64},Array...}
+ArrayReg{2, Complex{Float64}, Array...}
     active qubits: 4/4
 ```
 """
@@ -433,9 +433,9 @@ batch dimension.
 
 # Example
 
-```jldoctest
+```jldoctest; setup=:(using YaoArrayRegister)
 julia> repeat(ArrayReg{3}(bit"101"), 4)
-ArrayReg{12,Complex{Float64},Array...}
+ArrayReg{12, Complex{Float64}, Array...}
     active qubits: 3/3
 ```
 """