diff --git a/EpiAware/src/EpiAware.jl b/EpiAware/src/EpiAware.jl index e998ac06a..796fdeaad 100644 --- a/EpiAware/src/EpiAware.jl +++ b/EpiAware/src/EpiAware.jl @@ -29,14 +29,6 @@ An epidemiological model in `EpiAware` consists of composable structs with core of infection and the time of observation as a convolution, followed by a negative binomial distributed sample. -## Imports - -$(IMPORTS) - -## Exports - -$(EXPORTS) - """ module EpiAware @@ -57,6 +49,7 @@ export make_epi_aware # Exported utilities export create_discrete_pmf, spread_draws, scan +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) + """