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

Make non-user facing functions internal #225

Merged
merged 21 commits into from
Mar 22, 2024
Merged

Make non-user facing functions internal #225

merged 21 commits into from
Mar 22, 2024

Conversation

jamesmbaazam
Copy link
Member

@jamesmbaazam jamesmbaazam commented Mar 21, 2024

In this PR, I make a few changes:

  • The simulation and analytical likelihood functions are made internal functions (and unexported) to resolve Unexport functions not directly called by users #131.
  • The S3 constructors are also made internal to resolve Add examples to exported class constructors #160, removing the need to provide examples. Users are not expected to interact with the S3 functionality except for the print, summary, and aggregate methods.
  • All internal functions are renamed to follow the dot-prefix naming style.
  • A few documentation changes are also introduced. For example, where there was previously a "seealso" link to another function that has now been made internal, that tag is removed (See f5bec77 and 95637b4).

Other notes:

  • likelihood() is refactored slightly so that the NAMESPACE search is done with a dot prefix function.
  • The pkgdown Reference has been updated accordingly.
  • No tests are expected to fail, so none are updated.

@codecov-commenter
Copy link

codecov-commenter commented Mar 22, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.80%. Comparing base (07f6087) to head (ae324cd).
Report is 6 commits behind head on main.

❗ Current head ae324cd differs from pull request most recent head e3b6104. Consider uploading reports for the commit e3b6104 to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #225   +/-   ##
=======================================
  Coverage   98.80%   98.80%           
=======================================
  Files           8        8           
  Lines         584      587    +3     
=======================================
+ Hits          577      580    +3     
  Misses          7        7           

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

@jamesmbaazam jamesmbaazam merged commit 3fe2965 into main Mar 22, 2024
9 checks passed
@jamesmbaazam jamesmbaazam deleted the unexport-funcs branch March 22, 2024 14:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add examples to exported class constructors Unexport functions not directly called by users
2 participants