Merge pull request #48 from SimonEnsemble/tune_up_2024

doc tests run
SimonEnsemble · Feb 8, 2024 · b4a5d5a · b4a5d5a · SimonEnsemble · Feb 8, 2024
2 parents 9daffbe + 80d99b8
commit b4a5d5a
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 7 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,5 +1,6 @@
 using Documenter
 using Controlz
+using Polynomials
 
 # using Controlz before all docstrings
 DocMeta.setdocmeta!(Controlz, :DocTestSetup, :(using Controlz); recursive=true)
@@ -9,6 +10,7 @@ makedocs(
     modules = [Controlz],
  #     source = "src",
     doctest = true,
+    warnonly = true,
     sitename = "Controlz.jl",
     clean = true,
     pages = ["Controlz" => "index.md",

diff --git a/docs/src/tfs.md b/docs/src/tfs.md
@@ -53,13 +53,13 @@ as rational functions associated with a time delay, each `TransferFunction` data
 ```jldoctest gdef
 g.numerator
 # output
-Polynomials.Polynomial(1.0 + 5.0*s)
+Polynomial(1.0 + 5.0*s)
 ```
 
 ```jldoctest gdef
 g.denominator
 # output
-Polynomials.Polynomial(5.0 + 4.0*s + 1.0*s^2)
+Polynomial(5.0 + 4.0*s + 1.0*s^2)
 ```
 
 ```jldoctest gdef
@@ -240,7 +240,7 @@ margins.ω_g          # gain crossover freq. (radians / time)
 margins.gain_margin  # gain margin
 margins.phase_margin # phase margin (radians)
 # output
-1.7479849408794201
+1.74798494087942
 ```
 
 

diff --git a/src/systems.jl b/src/systems.jl
@@ -16,7 +16,7 @@ a polynomial of type `Polynomial`
 g_ol = 4 / (s + 3) / (s + 2) / (s + 1)
 characteristic_polynomial(g_ol)
 # output
-Polynomials.Polynomial(10.0 + 11.0*s + 6.0*s^2 + 1.0*s^3)
+Polynomial(10.0 + 11.0*s + 6.0*s^2 + 1.0*s^3)
 ```
 """
 function characteristic_polynomial(g_ol::TransferFunction)

diff --git a/src/tf.jl b/src/tf.jl
@@ -253,9 +253,6 @@ evaluate(tf, 1.0)
 # output
 0.25
 ```
-
-```jldoctest eval
-```
 """
 function evaluate(tf::TransferFunction, z::Number)
     return tf.numerator(z) / tf.denominator(z) * exp(-tf.time_delay * z)