Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docstrings for all latentmodel types and generate_latent plus named arguments for constructors #140

Conversation

SamuelBrand1
Copy link
Collaborator

This is a PR for documenting AbstractLatentModel subtypes and methods that dispatch on them.

Current focus and decisions:

Follows #138 in decisions.

This PR is aimed at addressing #139 which is part of #35 and #97 .

Extra activity

@SamuelBrand1 SamuelBrand1 marked this pull request as ready for review March 12, 2024 23:26
@SamuelBrand1 SamuelBrand1 requested a review from seabbs March 12, 2024 23:26
@SamuelBrand1 SamuelBrand1 added documentation Improvements or additions to documentation EpiAware labels Mar 12, 2024
@codecov-commenter
Copy link

codecov-commenter commented Mar 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.24%. Comparing base (b27d598) to head (3da35de).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #140   +/-   ##
=======================================
  Coverage   98.24%   98.24%           
=======================================
  Files          26       25    -1     
  Lines         228      228           
=======================================
  Hits          224      224           
  Misses          4        4           

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

@seabbs
Copy link
Collaborator

seabbs commented Mar 15, 2024

This PR has some major conflicts. Happy to resolve and then review.

@seabbs seabbs enabled auto-merge (squash) March 15, 2024 13:58
Copy link
Collaborator

@seabbs seabbs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me. @SamuelBrand1 can you check you are also happy?

EpiAware/src/abstract-types.jl Outdated Show resolved Hide resolved
@seabbs seabbs merged commit c407721 into main Mar 15, 2024
10 checks passed
@seabbs seabbs deleted the 139-document-all-latent-models-and-methods-that-dispatch-on-them-plus-adding-keyword-args-as-required branch March 15, 2024 14:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation EpiAware
Projects
None yet
Development

Successfully merging this pull request may close these issues.

document all latent models and methods that dispatch on them plus adding keyword args as required
3 participants