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

Remove simulate_tree() and simulate_tree_from_pop() and replace usage with simulate_chains() #182

Merged
merged 15 commits into from
Jan 26, 2024

Conversation

jamesmbaazam
Copy link
Member

This PR closes #181 by:

  • Unexporting and removing all occurrences of simulate_tree() and simulate_tree_from_pop(),
  • Replacing their use with simulate_chains() in tests, vignettes, and examples.

Additionally, where necessary, descriptions involving simulate_tree() and simulate_tree_from_pop() have been rephrased. Examples include the README (64015e1) and Getting Started vignettes (e38453a).

@jamesmbaazam jamesmbaazam added documentation Improvements or additions to documentation enhancement New feature or request labels Jan 25, 2024
@jamesmbaazam jamesmbaazam self-assigned this Jan 25, 2024
Copy link

This pull request:

  • Adds 0 new dependencies (direct and indirect)
  • Adds 0 new system dependencies
  • Removes 2 existing dependencies (direct and indirect)
  • Removes 1 existing system dependencies

(Note that results may be inacurrate if you branched from an outdated version of the target branch.)

@codecov-commenter
Copy link

codecov-commenter commented Jan 25, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (26748ba) 99.26% compared to head (bbdb332) 99.41%.

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

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #182      +/-   ##
==========================================
+ Coverage   99.26%   99.41%   +0.15%     
==========================================
  Files           8        8              
  Lines         682      517     -165     
==========================================
- Hits          677      514     -163     
+ Misses          5        3       -2     

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

@jamesmbaazam jamesmbaazam requested a review from sbfnk January 25, 2024 18:22
README.md Outdated Show resolved Hide resolved
Copy link
Contributor

@sbfnk sbfnk left a comment

Choose a reason for hiding this comment

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

LGTM

@sbfnk
Copy link
Contributor

sbfnk commented Jan 26, 2024

Also closes #158

@sbfnk sbfnk linked an issue Jan 26, 2024 that may be closed by this pull request
@jamesmbaazam
Copy link
Member Author

jamesmbaazam commented Jan 26, 2024

Thanks. #158 will be better addressed by #186.

@sbfnk
Copy link
Contributor

sbfnk commented Jan 26, 2024

Ah sorry yes that makes sense

@jamesmbaazam jamesmbaazam merged commit 9285cb0 into main Jan 26, 2024
9 checks passed
@jamesmbaazam jamesmbaazam deleted the remove-old-sim-funcs branch January 26, 2024 14:42
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 enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Remove simulate_tree() and simulate_tree_from_pop()
4 participants