document processes_to_mtkeqs and list in docs

Author: Datseris

CHANGELOG.md

@@ -3,6 +3,11 @@
 ProcessBasedModelling.jl follows semver 2.0.
 Changelog is kept with respect to v1 release.
 
+## 1.5
+
+- Add docstring to `processes_to_mtkeqs` and list it in the documentation.
+  (function was already exported but not made public in the docs)
+
 ## 1.4
 
 - Allow `TimeDerivative(p::Process)`.

Project.toml

@@ -1,7 +1,7 @@
 name = "ProcessBasedModelling"
 uuid = "ca969041-2cf3-4b10-bc21-86f4417093eb"
 authors = ["Datseris <[email protected]>"]
-version = "1.4.0"
+version = "1.5.0"
 
 [deps]
 ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"

docs/src/index.md

@@ -201,6 +201,7 @@ when developing a field-specific library.
 
 ```@docs
 processes_to_mtkmodel
+processes_to_mtkeqs
 register_default_process!
 default_processes
 default_processes_eqs

src/make.jl

@@ -3,7 +3,7 @@
 
 Construct a ModelingToolkit.jl model/system using the provided `processes` and `default` processes.
 The model/system is _not_ structurally simplified. Use the function
-`processes_to_mtkeqs` to obtain the raw `Vector{Equation}` before it is
+[`processes_to_mtkeqs`](@ref) to obtain the raw `Vector{Equation}` before it is
 passed to the MTK model/system like `ODESystem`.
 
 During construction, the following automations improve user experience:
@@ -62,6 +62,12 @@ function processes_to_mtkmodel(args...;
     return sys
 end
 
+"""
+    processes_to_mtkeqs(args...) → eqs
+
+Same as in [`processes_to_mtkmodel`](@ref), but return the created vector of `Equation`s
+before the are passed to an MTK system.
+"""
 processes_to_mtkeqs(procs::Vector; kw...) =
 processes_to_mtkeqs(procs, Dict{Num, Any}(); kw...)
 processes_to_mtkeqs(procs::Vector, m::Module; kw...) =