Skip to content

Commit

Permalink
Update API docs page
Browse files Browse the repository at this point in the history
  • Loading branch information
penelopeysm committed Dec 12, 2024
1 parent e1be1b5 commit 91996f9
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,7 +280,8 @@ TypedVarInfo
```

One main characteristic of [`VarInfo`](@ref) is that samples are transformed to unconstrained Euclidean space and stored in a linearized form, as described in the [transformation page](internals/transformations.md).
The following methods help with keeping track of whether samples are transformed or not.
The [Transformations section below](#Transformations) describes the methods used for this.
In the specific case of `VarInfo`, it keeps track of whether samples have been transformed by setting flags on them, using the following functions.

```@docs
set_flag!
Expand Down

0 comments on commit 91996f9

Please sign in to comment.