From eaa6c3f96c09256cd381993bbb3d430033970b83 Mon Sep 17 00:00:00 2001 From: Luke Morris Date: Wed, 5 Jun 2024 12:53:23 -0400 Subject: [PATCH] List API Ref modules manually --- docs/src/api.md | 17 ++++++++++++++++- src/ACSetInterface.jl | 2 +- src/Defaults.jl | 2 +- src/intertypes/InterTypes.jl | 2 +- 4 files changed, 19 insertions(+), 4 deletions(-) diff --git a/docs/src/api.md b/docs/src/api.md index 69e2c37..9578837 100644 --- a/docs/src/api.md +++ b/docs/src/api.md @@ -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] ``` diff --git a/src/ACSetInterface.jl b/src/ACSetInterface.jl index 609f1e1..9556102 100644 --- a/src/ACSetInterface.jl +++ b/src/ACSetInterface.jl @@ -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 diff --git a/src/Defaults.jl b/src/Defaults.jl index a956d0a..8a78b50 100644 --- a/src/Defaults.jl +++ b/src/Defaults.jl @@ -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 diff --git a/src/intertypes/InterTypes.jl b/src/intertypes/InterTypes.jl index 072f749..d299db0 100644 --- a/src/intertypes/InterTypes.jl +++ b/src/intertypes/InterTypes.jl @@ -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.