From 9655ac79d27e220471f2c565dfd5b6eaf172887b Mon Sep 17 00:00:00 2001 From: Sam Date: Fri, 1 Mar 2024 11:38:34 +0000 Subject: [PATCH] first pass at templates --- EpiAware/src/EpiAware.jl | 1 + EpiAware/src/docstrings.jl | 34 ++++++++++++++++++++++++++++++++++ 2 files changed, 35 insertions(+) create mode 100644 EpiAware/src/docstrings.jl diff --git a/EpiAware/src/EpiAware.jl b/EpiAware/src/EpiAware.jl index e7ddec694..2cc2286c5 100644 --- a/EpiAware/src/EpiAware.jl +++ b/EpiAware/src/EpiAware.jl @@ -53,6 +53,7 @@ export EpiData, Renewal, ExpGrowthRate, DirectInfections, AbstractModel, # Exported Turing model constructors export make_epi_aware +include("docstrings.jl") include("abstract-types.jl") include("epi-models.jl") include("utilities.jl") diff --git a/EpiAware/src/docstrings.jl b/EpiAware/src/docstrings.jl new file mode 100644 index 000000000..9395ba66a --- /dev/null +++ b/EpiAware/src/docstrings.jl @@ -0,0 +1,34 @@ +@template (FUNCTIONS, METHODS, MACROS) = """ + $(FUNCTIONNAME) + $(DOCSTRING) + + --- + # Signatures + $(TYPEDSIGNATURES) + --- + ## Methods + $(METHODLIST) + --- + ## Fields + $(TYPEDFIELDS) + """ + +@template (TYPES) = """ + $(TYPEDEF) + $(DOCSTRING) + + --- + ## Fields + $(TYPEDFIELDS) + """ + +@template MODULES = """ + $(DOCSTRING) + + --- + ## Exports + $(EXPORTS) + --- + ## Imports + $(IMPORTS) + """