CDCgov / cfa-viral-lineage-model

Apache License 2.0
10 stars 0 forks source link

Make config documentation user-accessible #31

Open afmagee42 opened 2 months ago

afmagee42 commented 2 months ago
          I am not a fan of the way we're interleaving important information about the config with code. Since these are comments in code, it's relatively hidden.

I would prefer we either make a separate md in docs/ describing this, or move it into accessible docstrings. My preference would be a separate static md, unless we can figure out how to make mkdocs stop printing a very hard-to-read dictionary.

_Originally posted by @afmagee42 in https://github.com/CDCgov/cfa-viral-lineage-model/pull/28#discussion_r1717543517_