Skip to content

Commit eefec54

Browse files
committed
test and documentation build errors fixed
- VariableResistor in src.Electrical.Analog.ideal_components modified -- Unit = descriptor removed -- No longer an UnboundError during Pkg.test() - make.jl in docs modified -- linkcheck_ignore added for the Mathworks link -- It seems the link works and is valid when manually visiting in browser -- No longer a 403 Forbidden error when running docs/make.jl
1 parent ab660ce commit eefec54

File tree

2 files changed

+6
-7
lines changed

2 files changed

+6
-7
lines changed

docs/make.jl

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ makedocs(sitename = "ModelingToolkitStandardLibrary.jl",
3131
ModelingToolkitStandardLibrary.Hydraulic,
3232
ModelingToolkitStandardLibrary.Hydraulic.IsothermalCompressible],
3333
clean = true, doctest = false, linkcheck = true,
34+
linkcheck_ignore = ["https://www.mathworks.com/help/simscape/ug/basic-principles-of-modeling-physical-networks.html#bq89sba-6"],
3435
warnonly = [:docs_block, :missing_docs, :cross_references],
3536
format = Documenter.HTML(assets = ["assets/favicon.ico"],
3637
canonical = "https://docs.sciml.ai/ModelingToolkitStandardLibrary/stable/"),

src/Electrical/Analog/ideal_components.jl

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -392,10 +392,9 @@ R = R_const + pos * R_ref * (1 + alpha * (port.T - T_ref))
392392

393393
@parameters begin
394394
R_ref = 1.0,
395-
[description = "Resistance at temperature T_ref when fully closed (pos=1.0)",
396-
unit = "Ω"]
397-
T_ref = 300.15, [description = "Reference temperature", unit = "K"]
398-
R_const = 1e-3, [description = "Constant resistance between p and n", unit = "Ω"]
395+
[description = "Resistance at temperature T_ref when fully closed (pos=1.0) (Ω)"]
396+
T_ref = 300.15, [description = "Reference temperature (K)"]
397+
R_const = 1e-3, [description = "Constant resistance between p and n (Ω)"]
399398
end
400399

401400
@components begin
@@ -404,13 +403,12 @@ R = R_const + pos * R_ref * (1 + alpha * (port.T - T_ref))
404403

405404
@variables begin
406405
pos(t), [description = "Position of the wiper (normally 0-1)"]
407-
R(t), [description = "Resistance", unit = "Ω"]
406+
R(t), [description = "Resistance (Ω)"]
408407
end
409408

410409
if T_dep
411410
@parameters begin
412-
alpha = 1e-3,
413-
[description = "Temperature coefficient of resistance", unit = "K^-1"]
411+
alpha = 1e-3, [description = "Temperature coefficient of resistance (K^-1)"]
414412
end
415413
@components begin
416414
port = HeatPort()

0 commit comments

Comments
 (0)