fix docs, add yml for julia formatting

Author: andre_ramos

.github/workflows/format-check.yml

@@ -0,0 +1,13 @@
+name: Format suggestions
+on:
+  pull_request:
+    # this argument is not required if you don't use the `suggestion-label` input
+    types: [ opened, reopened, synchronize, labeled, unlabeled ]
+jobs:
+  code-style:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: julia-actions/julia-format@v3
+        with:
+          version: '1' # Set `version` to '1.0.54' if you need to use JuliaFormatter.jl v1.0.54 (default: '1')
+          suggestion-label: 'format-suggest' # leave this unset or empty to show suggestions for all PRs

Project.toml

@@ -1,7 +1,7 @@
 name = "StateSpaceLearning"
 uuid = "971c4b7c-2c4e-4bac-8525-e842df3cde7b"
 authors = ["andreramosfc <[email protected]>"]
-version = "1.0.0"
+version = "1.0.1"
 
 [deps]
 Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"

README.md

@@ -20,10 +20,10 @@ model = StructuralModel(y)
 fit!(model)
 
 # Point Forecast
-prediction = StateSpaceLearning.forecast(output, 12) #Gets a 12 steps ahead prediction
+prediction = StateSpaceLearning.forecast(model, 12) #Gets a 12 steps ahead prediction
 
 # Scenarios Path Simulation
-simulation = StateSpaceLearning.simulate(output, 12, 1000) #Gets 1000 scenarios path of 12 steps ahead predictions
+simulation = StateSpaceLearning.simulate(model, 12, 1000) #Gets 1000 scenarios path of 12 steps ahead predictions
 ```
 
 ## StructuralModel Arguments

docs/src/manual.md

@@ -16,10 +16,10 @@ model = StructuralModel(y)
 fit!(model)
 
 # Point Forecast
-prediction = StateSpaceLearning.forecast(output, 12) #Gets a 12 steps ahead prediction
+prediction = StateSpaceLearning.forecast(model, 12) #Gets a 12 steps ahead prediction
 
 # Scenarios Path Simulation
-simulation = StateSpaceLearning.simulate(output, 12, 1000) #Gets 1000 scenarios path of 12 steps ahead predictions
+simulation = StateSpaceLearning.simulate(model, 12, 1000) #Gets 1000 scenarios path of 12 steps ahead predictions
 ```
 
 ## StructuralModel Arguments