Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

reorganize API docs #78

Merged
merged 2 commits into from
Mar 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 27 additions & 11 deletions docs/src/api.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,37 @@
```@docs
Functors.fmap
Functors.fmap_with_path
Functors.@functor
Functors.@leaf
```@meta
CurrentModule = Functors
```

# API

```@index
Modules = [Functors]
Pages = ["api.md"]
```

## Constructors and helpers

```@docs
Functors.@functor
Functors.@leaf
Functors.functor
Functors.children
Functors.isleaf
Functors.fcollect
Functors.fleaves
```

## Maps

```@docs
Functors.fmap
Functors.fmap_with_path
Functors.fmapstructure
Functors.fmapstructure_with_path
```

## Walks

```@docs
Functors.AbstractWalk
Functors.execute
Expand All @@ -23,12 +44,7 @@ Functors.AnonymousWalk
Functors.IterateWalk
```

```@docs
Functors.fmapstructure
Functors.fmapstructure_with_path
Functors.fcollect
Functors.fleaves
```
## KeyPath

```@docs
Functors.KeyPath
Expand Down
Loading