Skip to content

Commit

Permalink
format api
Browse files Browse the repository at this point in the history
  • Loading branch information
odunbar committed Jun 27, 2024
1 parent 460e797 commit 58a5b03
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/Observations.jl
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ Observation(
"names" => "one_two_three"
),
)
```
can stack up multiple observations with combine_observations, or by providing vectors of samples, covariances and names to the dictionary.
# Fields
Expand Down Expand Up @@ -219,7 +219,7 @@ end
"""
$(TYPEDSIGNATURES)
if build=true`, returns the stacked vector of observed samples `samples`(default), otherwise it calls `get_samples`
if `build=true`, returns the stacked vector of observed samples `samples`(default), otherwise it calls `get_samples`
"""
function get_obs(o::Observation; build = true)
if !build # return the blocks directly
Expand All @@ -238,7 +238,7 @@ end
"""
$(TYPEDSIGNATURES)
if build=true`, returns the block matrix of observation covariances `covs` (default), otherwise it calls `get_covs`
if `build=true`, returns the block matrix of observation covariances `covs` (default), otherwise it calls `get_covs`
"""
function get_obs_noise_cov(o::Observation; build = true)

Expand All @@ -265,7 +265,7 @@ end
"""
$(TYPEDSIGNATURES)
if build=true`, returns the block matrix of the inverses of the observation covariances `inv_covs` (default), otherwise it calls `get_inv_covs`
if `build=true`, returns the block matrix of the inverses of the observation covariances `inv_covs` (default), otherwise it calls `get_inv_covs`
"""
function get_obs_noise_cov_inv(o::Observation; build = true)

Expand Down Expand Up @@ -553,7 +553,7 @@ ObservationSeries(
"minibatcher" => minibatcher
),
)
```
# Fields
$(TYPEDFIELDS)
Expand Down

0 comments on commit 58a5b03

Please sign in to comment.