Organize API docs

This commit is contained in:
Thomas A. Christensen II 2022-12-31 15:15:44 -06:00
parent 2a7d61e43d
commit 6f7110caec

View file

@ -7,6 +7,54 @@ end
# API Reference # API Reference
```@autodocs ## Edits
Modules = [SequenceVariation]
```@docs
Substitution
Deletion
Insertion
```
## Variants
```@docs
Variant
reference(::Variant)
variations
reconstruct!
```
## Variations
```@docs
Variation
reference(::Variation)
mutation
translate
refbases
altbases
```
## Private API
### Edits
```@docs
Edit
_mutation
_lendiff
```
### Variants
```@docs
_edits
_is_valid(::Variant)
```
### Variations
```@docs
_edit
_is_valid(::Variation)
``` ```