Partial documentation of EpiAware and also sets documentation standard

[SamuelBrand1]

This PR gives partial documentation to EpiAware, mainly the module.

Also gives a standard for using DocStringExtensions.

[seabbs]

This is looking really nice and from a skim all looks good. Any idea what is going on in CI?

[SamuelBrand1]

This is looking really nice and from a skim all looks good. Any idea what is going on in CI?

The answer is that I was not being careful in adding deps!

EpiAware [b2eeebe4-5992-4301-9193-7ebc9f62c855] does not declare a compat entry for the following deps:
1-element Vector{Base.PkgId}:
DocStringExtensions [ffbed154-4ef7-542d-bbb7-c09d3a79fcae]

Will fix in the morning!

[seabbs]

sorry I haven't yet got to this in detail and also for the mess that #89 will bring to this

[seabbs]

shall i look at this now? Do you want to ping me to review (top right when ready?)

[SamuelBrand1]

shall i look at this now? Do you want to ping me to review (top right when ready?)

Yeah, there is not alot to review:

• Use of DocStringExtensions? Is it good/meh/bad.
• LaTex math... using escape (as per this PR) or some other solution, see here.

Second one I only just noticed.

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.74%. Comparing base (8441314) to head (e8b4829).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #85   +/-   ##
=======================================
  Coverage   97.74%   97.74%           
=======================================
  Files           6        6           
  Lines         133      133           
=======================================
  Hits          130      130           
  Misses          3        3           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[seabbs]

@ doc raw

This seems like a cleaner solution than escaping to me for Latex but we could address in its own issue. I definitely like DocStringExtensons (and we should make a template)

[SamuelBrand1]

@ doc raw

This seems like a cleaner solution than escaping to me for Latex but we could address in its own issue. I definitely like DocStringExtensons (and we should make a template)

I did a quick try on that, and the problem was that raw kills using the DocStringExtension interpolation... tricky!

E.g. raw string will just write $(TYPEDEF) as a string

[seabbs]

It looks like the docs are out of sync with the recent name changes and that AbstractModel isn't present (despite it appearing that this branch is up to date.

[seabbs]

I did a quick try on that, and the problem was that raw kills using the DocStringExtension interpolation... tricky!

ah okay. Lets port to another issue for discussion.

[seabbs]

s and that AbstractModel isn't present (despite it appearing that this branch is up to date.

It looks like this was missed in #89 but perhaps we are fine with it not being exported?

[SamuelBrand1]

I think this is ok now

[seabbs]

Aweesome will review now. Could you resolve out the things that are sorted?

[seabbs]

A few minor issues but otherwise good to go.