Merge pull request #12 from SciML/docstinrg

Fix docstrings

Author: ChrisRackauckas

LICENSE.md

@@ -1,4 +1,3 @@
-
 The MIT License (MIT)
 
 Copyright (c) 2023 Christopher Rackauckas

docs/make.jl

@@ -6,7 +6,7 @@ cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
 pages = [
     "Home" => "index.md",
     "interface.md",
-    "api.md",
+    "api.md"
 ]
 
 ENV["GKSwstype"] = "100"

docs/src/index.md

@@ -21,7 +21,7 @@ Pkg.add("SciMLStructures")
 
   - See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions.
   - There are a few community forums:
-
+    
       + The #diffeq-bridged and #sciml-bridged channels in the
         [Julia Slack](https://julialang.org/slack/)
       + The #diffeq-bridged and #sciml-bridged channels in the

docs/src/interface.md

@@ -28,22 +28,24 @@ to the solver how to represent the given "portion" in a standard `AbstractVector
 interfacing with standard tools like linear algebra in an efficient manner. The type of portions which
 are defined are:
 
-* Tunable: the tunable values/parameters, i.e. the values of the structure which are supposed to be considered
-  non-constant when used in the context of an inverse problem solve. For example, this is the set of
-  parameters to be optimized during a parameter estimation of an ODE.
-    * Tunable parameters are expected to return an `AbstractVector` of unitless values.
-    * Tunable parameters are expected to be constant during the solution of the ODE.
-* Constants: the values which are to be considered constant by the solver, i.e. values which are not estimated
-  in an inverse problem and which are unchanged in any operation by the user as part of the solver's usage.
-* Caches: the stored cache values of the struct, i.e. the values of the structure which are used as intermediates
-  within other computations in order to avoid extra allocations.
-* Discrete: the discrete portions of the state captured inside of the structure. For example, discrete values
-  stored outside of the `u` in the parameters to be modified in the callbacks of an ODE.
-    * Any parameter that is modified inside of callbacks should be considered Discrete.
+  - Tunable: the tunable values/parameters, i.e. the values of the structure which are supposed to be considered
+    non-constant when used in the context of an inverse problem solve. For example, this is the set of
+    parameters to be optimized during a parameter estimation of an ODE.
+    
+      + Tunable parameters are expected to return an `AbstractVector` of unitless values.
+      + Tunable parameters are expected to be constant during the solution of the ODE.
+  - Constants: the values which are to be considered constant by the solver, i.e. values which are not estimated
+    in an inverse problem and which are unchanged in any operation by the user as part of the solver's usage.
+  - Caches: the stored cache values of the struct, i.e. the values of the structure which are used as intermediates
+    within other computations in order to avoid extra allocations.
+  - Discrete: the discrete portions of the state captured inside of the structure. For example, discrete values
+    stored outside of the `u` in the parameters to be modified in the callbacks of an ODE.
+    
+      + Any parameter that is modified inside of callbacks should be considered Discrete.
 
 ## Definitions for Base Objects
 
-* `Vector`: returns an aliased version of itself as `Tunable`, and an empty vector matching type for `Constants`,
-  `Caches`, and `Discrete`.
-* `Array`: returns the `vec(p)` aliased version of itself as `Tunable`, and an empty vector matching type for `Constants`,
-  `Caches`, and `Discrete`.
+  - `Vector`: returns an aliased version of itself as `Tunable`, and an empty vector matching type for `Constants`,
+    `Caches`, and `Discrete`.
+  - `Array`: returns the `vec(p)` aliased version of itself as `Tunable`, and an empty vector matching type for `Constants`,
+    `Caches`, and `Discrete`.

src/interface.jl

@@ -31,17 +31,14 @@ are defined are:
     non-constant when used in the context of an inverse problem solve. For example, this is the set of
     parameters to be optimized during a parameter estimation of an ODE.
     * Tunable parameters are expected to return an `AbstractVector` of unitless values.
+    * Tunable parameters are expected to be constant during the solution of the ODE.
 * Constants: the values which are to be considered constant by the solver, i.e. values which are not estimated
     in an inverse problem and which are unchanged in any operation by the user as part of the solver's usage.
 * Caches: the stored cache values of the struct, i.e. the values of the structure which are used as intermediates
     within other computations in order to avoid extra allocations.
 * Discrete: the discrete portions of the state captured inside of the structure. For example, discrete values
     stored outside of the `u` in the parameters to be modified in the callbacks of an ODE.
-
-## Structural Emptiness
-
-If `hasportion(::AbstractPortion, p) == false`, then the canonical return is
-`nothing, nothing, nothing`.
+    * Any parameter that is modified inside of callbacks should be considered Discrete.
 
 ## Definitions for Base Objects