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

Render API Reference page #140

Merged
merged 1 commit into from
Jun 7, 2024
Merged
Show file tree
Hide file tree
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
17 changes: 16 additions & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Library Reference

```@autodocs
Modules = [ACSets]
Modules = [
ACSetInterface,
ACSetSerialization,
ACSets,
ACSets.ColumnImplementations,
ACSets.Columns,
ACSets.Defaults,
DenseACSets,
ExcelACSets,
ACSets.IndexUtils,
InterTypes,
JSONACSets,
ACSets.Mappings,
NautyInterface,
ACSets.PreimageCaches,
Schemas]
```
2 changes: 1 addition & 1 deletion src/ACSetInterface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -400,7 +400,7 @@ function tables end
"""
Garbage collect in an acset.

For some choices of [`IDAllocator`](@ref), this function is a no-op.
For some choices of [`PartsType`](@ref), this function is a no-op.
"""
function gc! end

Expand Down
2 changes: 1 addition & 1 deletion src/Defaults.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ export Default, default, isdefault, DefaultVal, DefaultEmpty

"""
This is a hack in order to pass in a default initializer for
[`DefaultVecMap`](@ref) as a type parameter
`DefaultVecMap` as a type parameter
"""
abstract type Default end

Expand Down
2 changes: 1 addition & 1 deletion src/intertypes/InterTypes.jl
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import ..Schemas: toexpr
#######################

"""
A field of a struct. Used in [`Variant`](@ref) and [`Record`](@ref).
A field of a struct. Used in [`Variant`](@ref) and `Record`.

The `T` parameter will always be [`InterType`](@ref), but this is mutually-recursive
with `InterType` so we have to be generic here.
Expand Down
Loading