docs fixes more

bmad-sim · Jan 22, 2025 · 2eeb7e6 · 2eeb7e6
1 parent d66575d
commit 2eeb7e6
Show file tree

Hide file tree

Showing 6 changed files with 26 additions and 26 deletions.
diff --git a/docs/src/man/b_descriptor.md b/docs/src/man/b_descriptor.md
@@ -25,12 +25,12 @@ GTPSA.desc_current = d # Used in dynamic Descriptor resolution
 
 
 ## Examples
-```@repl desc
+```@repl
 using GTPSA #hide
-d1 = Descriptor(2, 10)         
-d2 = Descriptor([1, 2, 3], 5)     
-d3 = Descriptor(3, 4, 1, 2)    
-d4 = Descriptor([6, 5], 8, [4, 3], 7)   
+da = Descriptor(2, 10)         
+db = Descriptor([1, 2, 3], 5)     
+dc = Descriptor(3, 4, 1, 2)    
+dd = Descriptor([6, 5], 8, [4, 3], 7)   
 GTPSA.desc_current = d1
 ```
 

diff --git a/docs/src/man/c_tps.md b/docs/src/man/c_tps.md
@@ -38,10 +38,10 @@ d1 = Descriptor(1, 1); # 1 variable to order 1
 t1_1 = TPS{d1}()
 t2_1 = TPS{d1}(5im)
 t3_1 = TPS{d1}(t2_1)
-d2 = Descriptor(1, 10); # New Descriptor to order 10
-t1_2 = TPS64{d2}() # Uses d2
-t2_2 = ComplexTPS64{d2}(6)
-t3_2 = ComplexTPS64{d2}(t3_1) # Promotes and changes Descriptor
+d10 = Descriptor(1, 10); # New Descriptor to order 10
+t1_2 = TPS64{d10}() # Uses d10
+t2_2 = ComplexTPS64{d10}(6)
+t3_2 = ComplexTPS64{d10}(t3_1) # Promotes and changes Descriptor
 ```
 
 ## Dynamic `Descriptor` Resolution
@@ -70,10 +70,10 @@ d1 = Descriptor(1, 1); # 1 variable to order 1
 t1_1 = TPS()
 t2_1 = TPS(5im)
 t3_1 = TPS(t2_1)
-d2 = Descriptor(1, 10); # New Descriptor to order 10
-t1_2 = TPS64() # Uses d2
+d10 = Descriptor(1, 10); # New Descriptor to order 10
+t1_2 = TPS64() # Uses d10
 t2_2 = ComplexTPS64(6)
-t3_2 = ComplexTPS64(t3_1, use=d2) # Promotes and changes Descriptor
+t3_2 = ComplexTPS64(t3_1, use=d10) # Promotes and changes Descriptor
 ```
 
 ## Documentation

diff --git a/docs/src/man/d_varsparams.md b/docs/src/man/d_varsparams.md
@@ -23,11 +23,11 @@
 ## Examples
 ```@repl desc
 using GTPSA; GTPSA.show_sparse = false; #hide
-d1 = Descriptor(3, 5, 2, 5); # 3 vars, 2 params, all to order 5
-Δx = @vars(d1)
-Δxc = @vars(d1, complex=true)
-Δxd = @vars(d1, dynamic=true)
-Δk = @params(d1, complex=true, dynamic=true)
+d5 = Descriptor(3, 5, 2, 5); # 3 vars, 2 params, all to order 5
+Δx = @vars(d5)
+Δxc = @vars(d5, complex=true)
+Δxd = @vars(d5, dynamic=true)
+Δk = @params(d5, complex=true, dynamic=true)
 ```
 
 ## Documentation

diff --git a/docs/src/man/f_mono.md b/docs/src/man/f_mono.md
@@ -18,14 +18,14 @@ m = mono(TPS{Float64|ComplexF64 [, GTPSA.Dynamic]} monomialindex [, use=(descrip
 ## Examples
 ```@repl desc
 using GTPSA; GTPSA.show_sparse = false; # hide
-d1 = Descriptor(3, 15, 2, 15); # 3 vars, 2 params, all to order 15
+d15 = Descriptor(3, 15, 2, 15); # 3 vars, 2 params, all to order 15
 mono(1)
-mono(TPS64{d}, 1)
-mono(ComplexTPS64{d}, param=1)
-mono(TPS64, [3,1,2], use=d1)
-mono(TPS64{d}, (3,1,2,2,1))
+mono(TPS64{d15}, 1)
+mono(ComplexTPS64{d15}, param=1)
+mono(TPS64, [3,1,2], use=d15)
+mono(TPS64{d15}, (3,1,2,2,1))
 mono([1=>3, 2=>1, 3=>3])
-mono((1=>3, 2=>1, 3=>2), params=(1=>2, 2=>1), use=d1)
+mono((1=>3, 2=>1, 3=>2), params=(1=>2, 2=>1), use=d15)
 ```
 
 ## Documentation

diff --git a/docs/src/man/l_global.md b/docs/src/man/l_global.md
@@ -20,9 +20,9 @@ show_sparse::Bool = false    # Use sparse monomial print
 ```@repl
 using GTPSA; GTPSA.show_sparse = false; #hide
 GTPSA.desc_current
-d1 = Descriptor(1, 6);
+d6 = Descriptor(1, 6);
 GTPSA.desc_current
-x = @vars()
+t = TPS()
 GTPSA.show_sparse = true;
 x
 GTPSA.show_sparse = false;

diff --git a/docs/src/quickstart.md b/docs/src/quickstart.md
@@ -5,7 +5,7 @@ We first must define a `Descriptor` which includes all information about a GTPSA
 ```@example desc
 using GTPSA #hide
 # 2 variables with max truncation order 10
-d1 = Descriptor(2, 10)     
+d10 = Descriptor(2, 10)     
 ```
 
 ## Calculating a Truncated Power Series