refactor: mark renamespace, namespace_equations as public

Author: AayushSabharwal

docs/src/API/System.md

@@ -213,3 +213,14 @@ ModelingToolkit.collect_vars!
 ModelingToolkit.eqtype_supports_collect_vars
 ModelingToolkit.modified_unknowns!
 ```
+
+## Namepsace manipulation
+
+ModelingToolkit namespaces variables from subsystems when using them in a parent system to
+disambiguate from identically named variables in other subsystems or the parent system. The
+following functions are useful for manipulating namespacing functionality.
+
+```@docs
+ModelingToolkit.renamespace
+ModelingToolkit.namespace_equations
+```

src/ModelingToolkit.jl

@@ -344,6 +344,7 @@ export DynamicOptSolution
 @public VariableOutput, VariableStatePriority, VariableUnit, collect_scoped_vars!
 @public collect_var_to_name!, collect_vars!, eqtype_supports_collect_vars, hasdefault
 @public getdefault, setdefault, iscomplete, isparameter, modified_unknowns!
+@public renamespace, namespace_equations
 
 for prop in [SYS_PROPS; [:continuous_events, :discrete_events]]
     getter = Symbol(:get_, prop)

src/systems/abstractsystem.jl

@@ -1095,6 +1095,12 @@ end
 renamespace(sys, eq::Equation) = namespace_equation(eq, sys)
 
 renamespace(names::AbstractVector, x) = foldr(renamespace, names, init = x)
+
+"""
+    $(TYPEDSIGNATURES)
+
+Namespace `x` with the name of `sys`.
+"""
 function renamespace(sys, x)
     sys === nothing && return x
     x = unwrap(x)
@@ -1141,6 +1147,11 @@ function namespace_guesses(sys)
     Dict(unknowns(sys, k) => namespace_expr(v, sys) for (k, v) in guess)
 end
 
+"""
+    $(TYPEDSIGNATURES)
+
+Return `equations(sys)`, namespaced by the name of `sys`.
+"""
 function namespace_equations(sys::AbstractSystem, ivs = independent_variables(sys))
     eqs = equations(sys)
     isempty(eqs) && return Equation[]
@@ -1162,6 +1173,11 @@ function namespace_tstops(sys::AbstractSystem)
     end
 end
 
+"""
+    $(TYPEDSIGNATURES)
+
+Namespace the given equation with the name of the given system `sys`.
+"""
 function namespace_equation(eq::Equation,
         sys,
         n = nameof(sys);