Skip to content

Commit 1a22373

Browse files
committed
fix spelling and grammar
1 parent 2883a6b commit 1a22373

File tree

1 file changed

+9
-10
lines changed

1 file changed

+9
-10
lines changed

docs/src/inspector.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Interactive Solution Inspection
22

3-
Interactive solution inspection tool based on [WGLMakie](https://makie.org/website/) and [Bonito](https://github.com/SimonDanisch/Bonito.jl) are provided through the helper package `NetworkDynamicsInspector`.
3+
An interactive solution inspection tool based on [WGLMakie](https://makie.org/website/) and [Bonito](https://github.com/SimonDanisch/Bonito.jl) is provided through the helper package `NetworkDynamicsInspector`.
44

5-
Firstoff, we need to define the system we want to interactively inspect.
5+
First, we need to define the system we want to inspect.
66

77
!!! details "Define some network, simulate it and get a solution object"
88
```@example ndi
@@ -63,7 +63,7 @@ Firstoff, we need to define the system we want to interactively inspect.
6363
sol = get_sol()
6464
```
6565

66-
No that we have and `ODESolution` `sol`, we can call [`inspect`](@ref) to open the inspector gui. In the docstring you can find several options to chose how the app is displayed.
66+
Now that we have an `ODESolution` `sol`, we can call [`inspect`](@ref) to open the inspector GUI. The docstring provides several options to customize how the app is displayed.
6767

6868
```@example ndi
6969
inspect(sol; reset=true)
@@ -77,14 +77,13 @@ NDI.save_electron_screenshot("screenshot.png") #hide
7777
![screenshot](screenshot.png)
7878

7979

80-
## Programmatric Acces and GUI State manipulation
81-
Internally, the `NetworkDynamicsInspector` holds a global reference to an object `AppState`. This AppState reflects the changes the user made to the GUI and can be also altered programmaticially.
80+
## Programmatic Access and GUI State Manipulation
81+
Internally, the `NetworkDynamicsInspector` maintains a global reference to an `AppState` object. This AppState reflects changes made to the GUI by the user and can also be modified programmatically.
8282

83-
See [NetworkDynamicsInspector API](@ref) for a list of all available function.
84-
As a good starting point, there is a function [`dump_app_state`](@ref)
85-
which helps you to recreate the GUI state which was previously adjusted by hand.
83+
See the [NetworkDynamicsInspector API](@ref) for a complete list of available functions.
84+
A good starting point is the [`dump_app_state`](@ref) function, which helps you recreate a GUI state that was previously configured manually.
8685

87-
Lets say we've adjuste the appstate to include another timeseries plot for the node states.
86+
Let's say we've adjusted the AppState to include an additional time series plot for the node states.
8887

8988
```@example ndi
9089
set_state!(; t=1.75) #hide
@@ -111,6 +110,6 @@ sleep(1) #hide
111110
eval(Meta.parse("begin;"*code*"end;")) #hide
112111
sleep(3) #hide
113112
NDI.save_electron_screenshot("screenshot2.png") #hide
114-
"copy-paste and execute code returned by `dump_app_state` here"
113+
"copy-paste and execute code returned by `dump_app_state` here" #hide
115114
```
116115
![screenshot](screenshot2.png)

0 commit comments

Comments
 (0)