Warnings about unstable API.

QuantumSavory · Jan 10, 2022 · ae2f82f · ae2f82f · Krastanov · Jan 10, 2022
1 parent 9dee9ae
commit ae2f82f
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 2 deletions.
diff --git a/docs/src/graphs.md b/docs/src/graphs.md
@@ -1,5 +1,8 @@
 # [Graph States](@id Graph-States)
 
+!!! warning "The `graphstate` API is not considered stable"
+    `graphstate` returns a lot of information about encoding a given stabilizer state in a graph. A different API is being designed that streamlines the work with graph states.
+
 Conversion to and from [graph states](https://en.wikipedia.org/wiki/Graph_state) is possible.
 
 Consider a GHZ state:

diff --git a/docs/src/noisycircuits_API.md b/docs/src/noisycircuits_API.md
@@ -1,6 +1,7 @@
 # Full API (autogenerated)
 
-This is experimental functionality with an unstable API.
+!!! warning "Unstable"
+    This is experimental functionality with an unstable API.
 
 ```@autodocs
 Modules = [QuantumClifford.Experimental.NoisyCircuits]

diff --git a/docs/src/noisycircuits_mc.md b/docs/src/noisycircuits_mc.md
@@ -8,6 +8,9 @@ end
 CurrentModule = QuantumClifford.Experimental.NoisyCircuits
 ```
 
+!!! warning "Unstable"
+    This is experimental functionality with an unstable API.
+
 Import with `using QuantumClifford.Experimental.NoisyCircuits`.
 
 This module enables the simulation of noisy Clifford circuits through a Monte Carlo method where the same circuit is evaluated multiple times with random errors interspersed through it as prescribed by a given error model.

diff --git a/docs/src/noisycircuits_ops.md b/docs/src/noisycircuits_ops.md
@@ -8,7 +8,10 @@ end
 CurrentModule = QuantumClifford.Experimental.NoisyCircuits
 ```
 
-Available by `using QuantumClifford.Experimental.NoisyCircuits`.
+!!! warning "Unstable"
+    This is experimental functionality with an unstable API.
+
+Import with `using QuantumClifford.Experimental.NoisyCircuits`.
 
 ## Unitary Gates
 

diff --git a/docs/src/noisycircuits_perturb.md b/docs/src/noisycircuits_perturb.md
@@ -8,6 +8,9 @@ end
 CurrentModule = QuantumClifford.Experimental.NoisyCircuits
 ```
 
+!!! warning "Unstable"
+    This is experimental functionality with an unstable API.
+
 Import with `using QuantumClifford.Experimental.NoisyCircuits`.
 
 This module enables the simulation of noisy Clifford circuits through a perturbative expansion in the noise parameter (assuming the noise is small).