Merge pull request #4545 from KristofferC/kc/typos_whitespace

kc/typos whitespace

Author: AayushSabharwal

.github/workflows/Documentation.yml

@@ -1,40 +1,40 @@
-name: Documentation
-
-on:
-  push:
-    branches:
-      - master
-      - v10
-      - 'as/su-v4'
-    tags: '*'
-  pull_request:
-
-concurrency:
-  # Skip intermediate builds: always, but for the master branch.
-  # Cancel intermediate builds: always, but for the master branch.
-  group: ${{ github.workflow }}-${{ github.ref }}
-  cancel-in-progress: ${{ github.ref != 'refs/heads/master' && github.refs != 'refs/tags/*'}}
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v6
-      - uses: julia-actions/setup-julia@latest
-        with:
-          version: 'lts'
-      - run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
-      - name: Install dependencies
-        run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs/ -e 'using Pkg; Pkg.develop([PackageSpec(path=pwd()), PackageSpec(path=joinpath(pwd(), "lib", "ModelingToolkitBase")), PackageSpec(path=joinpath(pwd(), "lib", "SciCompDSL"))]); Pkg.instantiate()'
-      - name: Build and deploy
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
-          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
-          JULIA_DEBUG: "Documenter"
-        run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs/ --code-coverage=user docs/make.jl
-      - uses: julia-actions/julia-processcoverage@v1
-      - uses: codecov/codecov-action@v6
-        with:
-          files: lcov.info
-          token: ${{ secrets.CODECOV_TOKEN }}
-          fail_ci_if_error: true
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+      - v10
+      - 'as/su-v4'
+    tags: '*'
+  pull_request:
+
+concurrency:
+  # Skip intermediate builds: always, but for the master branch.
+  # Cancel intermediate builds: always, but for the master branch.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ github.ref != 'refs/heads/master' && github.refs != 'refs/tags/*'}}
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: 'lts'
+      - run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
+      - name: Install dependencies
+        run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs/ -e 'using Pkg; Pkg.develop([PackageSpec(path=pwd()), PackageSpec(path=joinpath(pwd(), "lib", "ModelingToolkitBase")), PackageSpec(path=joinpath(pwd(), "lib", "SciCompDSL"))]); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
+          JULIA_DEBUG: "Documenter"
+        run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24' julia --project=docs/ --code-coverage=user docs/make.jl
+      - uses: julia-actions/julia-processcoverage@v1
+      - uses: codecov/codecov-action@v6
+        with:
+          files: lcov.info
+          token: ${{ secrets.CODECOV_TOKEN }}
+          fail_ci_if_error: true

.github/workflows/SpellCheck.yml

@@ -10,4 +10,4 @@ jobs:
       - name: Checkout Actions Repository
         uses: actions/checkout@v6
       - name: Check spelling
-        uses: crate-ci/typos@v1.18.0 
+        uses: crate-ci/typos@v1.18.0

.typos.toml

@@ -7,3 +7,7 @@ ser = "ser"
 isconnection = "isconnection"
 Ue = "Ue"
 Derivate = "Derivate"
+missings = "missings"
+alph = "alph"
+fo = "fo"
+shs = "shs"

LICENSE.md

@@ -2,33 +2,33 @@ The ModelingToolkit.jl package is licensed under the MIT "Expat" License:
 
 > Copyright (c) 2018-22: Yingbo Ma, Christopher Rackauckas, Julia Computing, and
 > contributors
-> 
+>
 > Permission is hereby granted, free of charge, to any person obtaining a copy
-> 
+>
 > of this software and associated documentation files (the "Software"), to deal
-> 
+>
 > in the Software without restriction, including without limitation the rights
-> 
+>
 > to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-> 
+>
 > copies of the Software, and to permit persons to whom the Software is
-> 
+>
 > furnished to do so, subject to the following conditions:
-> 
+>
 > The above copyright notice and this permission notice shall be included in all
-> 
+>
 > copies or substantial portions of the Software.
-> 
+>
 > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-> 
+>
 > IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-> 
+>
 > FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-> 
+>
 > AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-> 
+>
 > LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-> 
+>
 > OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-> 
+>
 > SOFTWARE.

NEWS.md

@@ -488,7 +488,7 @@ now always performs this wrapping.
 ### Upgrade guide
 
   - The function `states` is renamed to `unknowns`. In a similar vein:
-    
+
       + `unknown_states` is now `solved_unknowns`.
       + `get_states` is `get_unknowns`.
       + `get_unknown_states` is now `get_solved_unknowns`.
@@ -498,7 +498,7 @@ now always performs this wrapping.
   - ModelingToolkit.jl now exports common definitions of `t` (time independent variable)
     and `D` (the first derivative with respect to `t`). Any models made using ModelingToolkit.jl
     should leverage these common definitions. There are three variants:
-    
+
       + `t` and `D` use DynamicQuantities.jl units. This is the default for standard library
         components.
       + `t_unitful` and `D_unitful` use Unitful.jl units.
@@ -522,7 +522,7 @@ now always performs this wrapping.
     parameters. Their value cannot be modified directly. Whenever a parameter value is changed, dependent
     parameter values are recalculated. For example, if `@parameters p1 p2 = 3p1` then `p2` can not be
     modified directly. If `p1` is changed, then `p2` will be updated accordingly. To restore the old behavior:
-    
+
       + Pass the `split = false` keyword to `structural_simplify`. E.g. `ss = structural_simplify(sys; split = false)`.
       + Pass `split = false` to `@mtkbuild`. E.g. `@mtkbuild sys = ODESystem(...) split = false`.
   - Discrete-time system using `Difference` are unsupported. Instead, use the new `Clock`-based syntax.

docs/src/API/System.md

@@ -126,7 +126,7 @@ namespaced version of `var`. Note that this can also be used to access subsystem
 or analysis points.
 
 !!! note
-    
+
     By default, top-level systems not marked as `complete` will apply their namespace. Systems
     marked as `complete` will not do this namespacing. This namespacing behavior can be toggled
     independently of whether the system is completed using [`toggle_namespacing`](@ref) and the

docs/src/API/model_building.md

@@ -242,7 +242,7 @@ has the ability to represent them. Compilation strategies can be implemented ind
 on top of [`mtkcompile`](@ref) using the `additional_passes` functionality.
 
 !!! warn
-    
+
     These operators are considered experimental API.
 
 ```@docs; canonical = false
@@ -266,7 +266,7 @@ While ModelingToolkit has the capability to represent state machines, it lacks t
 to compile and simulate them.
 
 !!! warn
-    
+
     This functionality is considered experimental API
 
 ```@docs

docs/src/API/variables.md

@@ -251,7 +251,7 @@ ModelingToolkit.isconstant
 ```
 
 !!! note
-    
+
     [`@constants`](@ref) is a convenient way to create `@parameters` with `tunable = false`
     metadata
 
@@ -422,7 +422,7 @@ system happen at discrete intervals on a clock. While ModelingToolkit cannot yet
 such systems, it has the capability to represent them.
 
 !!! warn
-    
+
     These operators are considered experimental API.
 
 ```@docs

docs/src/basics/Events.md

@@ -76,7 +76,7 @@ event = SymbolicDiscreteCallback(
 This way, we enforce that `y` will remain the same, and `p` will change.
 
 !!! warning
-    
+
     Symbolic affects come with the guarantee that the state after the callback
     will be consistent. However, when using [general functional affects](@ref func_affects)
     or [imperative affects](@ref imp_affects) one must be more careful. In

docs/src/basics/InputOutput.md

@@ -29,7 +29,7 @@ ModelingToolkit can generate the dynamics of a system, the function ``M\dot x =
 This function takes a vector of variables that are to be considered inputs, i.e., part of the vector ``u``. Alongside returning the function ``f``, [`ModelingToolkit.generate_control_function`](@ref) also returns the chosen state realization of the system after simplification. This vector specifies the order of the state variables ``x``, while the user-specified vector `u` specifies the order of the input variables ``u``.
 
 !!! note "Un-simplified system"
-    
+
     This function expects `sys` to be un-simplified, i.e., `mtkcompile` or `@mtkcompile` should not be called on the system before passing it into this function. `generate_control_function` calls a special version of `mtkcompile` internally.
 
 ### Example: