Merge pull request #104 from CDCgov/issue101

Issue 101: Add documention templates
CDCgov · Mar 1, 2024 · 00c7f43 · 00c7f43
2 parents a8d96a0 + e37c4e1
commit 00c7f43
Show file tree

Hide file tree

Showing 2 changed files with 35 additions and 8 deletions.
diff --git 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
@@ -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)
+                    """