fix the documentation build warnings

QuantumSavory · Jan 22, 2024 · 52d54a2 · 52d54a2
1 parent caf207e
commit 52d54a2
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 4 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -21,8 +21,7 @@ clean = true,
 sitename = "QuantumClifford.jl",
 format = Documenter.HTML(size_threshold_ignore = ["API.md"]),
 modules = [QuantumClifford, QuantumClifford.Experimental.NoisyCircuits, QuantumClifford.ECC, QuantumInterface],
-warnonly = true, # uncomment if you are having trouble building the docs and are debugging
-#warnonly = [:missing_docs],
+warnonly = [:missing_docs],
 authors = "Stefan Krastanov",
 pages = [
 "QuantumClifford.jl" => "index.md",

diff --git a/docs/src/ECC_evaluating.md b/docs/src/ECC_evaluating.md
@@ -1,5 +1,13 @@
 # [Evaluating an ECC code and decoders](@id ecc_evaluating)
 
+```@meta
+DocTestSetup = quote
+    using QuantumClifford
+    using QuantumClifford.ECC
+end
+CurrentModule = QuantumClifford.ECC
+```
+
 !!! warning "The documentation is incomplete"
     While waiting for a better documentation than the small example below, consider looking into [`evaluate_decoder`](@ref), [`TableDecoder`](@ref), [`BeliefPropDecoder`](@ref), [`PyBeliefPropDecoder`](@ref), [`PyMatchingDecoder`](@ref), [`CommutationCheckECCSetup`](@ref), [`NaiveSyndromeECCSetup`](@ref), [`ShorSyndromeECCSetup`](@ref)
 

diff --git a/docs/src/references.md b/docs/src/references.md
@@ -22,6 +22,12 @@ These publications describe the uniform sampling of random stabilizer states:
 - [berg2020simple](@cite)
 - [li2019measurement](@cite)
 
+For circuit construction routines (for stabilizer measurements for a given code):
+- [cleve1997efficient](@cite)
+- [gottesman1997stabilizer](@cite) (and its erratum)
+- [grassl2002algorithmic](@cite)
+- [grassl2011variations](@cite)
+
 # References
 
 ```@bibliography

diff --git a/src/ecc/circuits.jl b/src/ecc/circuits.jl
@@ -7,10 +7,10 @@ The initial physical qubits to be encoded have to be at indices `n-k+1:n`.
     Instead, you should measure the stabilizers of the code and the logical observables,
     thus projecting into the code space (which can be fault-tolerant).
 
-The canonicalization operation performed on the code may permute the qubits (see [canonicalize_gott!](@ref)).
+The canonicalization operation performed on the code may permute the qubits (see [`canonicalize_gott!`](@ref)).
 That permutation is corrected for with SWAP gates by default (controlled by the `undoperm` keyword argument).
 
-Based on [gottesman1997stabilizer](@cite) and [cleve1997efficient](@cite),
+Based on [cleve1997efficient](@cite) and [gottesman1997stabilizer](@cite),
 however it seems the published algorithm has some errors.
 Consult the erratum, as well as the more recent [grassl2002algorithmic](@cite) and [grassl2011variations](@cite),
 and be aware that this implementation also uses H instead of Z gates.