-
Notifications
You must be signed in to change notification settings - Fork 2
Release prep/fix package size #70
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
Conversation
Rename `use-precomputed-test-results` feature to `precomputed-test-results` to comply with Rust crate development guidelines.
Fix README to describe Dima's future feature properly, add ARPIP paper link.
Co-authored-by: Mattes Mrzik <[email protected]>
Co-authored-by: Mattes Mrzik <[email protected]>
Added comment to the cost function definition so that users know that the function is maximised and should be negated if it should be minimised.
…into release-preparation
Remove sequence_file method from PhyloBuilder as the sequence file path is the minimal configuration PhyloInfo needs to be properly created.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR reduces the crate’s final package size by moving small test data into examples/data and cleaning up the builder API.
- Moves all small data files used in doctests into
examples/dataand updates paths accordingly - Removes the redundant
sequence_filesetter method fromPhyloInfoBuilder - Updates
Cargo.tomlto exclude the old data directory and other non-shipped folders
Reviewed Changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| phylo/src/phylo_info/phyloinfo_builder.rs | Updated doctest paths to examples/data and removed sequence_file setter |
| phylo/src/phylo_info/mod.rs | Updated example paths in docs to examples/data |
| phylo/src/optimisers/topo_optimiser.rs | Updated example path for K80 data |
| phylo/src/io/mod.rs | Updated all doctest paths for sequence/tree I/O |
| phylo/examples/data/* | Added moved data files |
| phylo/Cargo.toml | Adjusted exclude patterns to drop data/, add benches/ and target/ |
| README.md | Updated sample code path for K80.fasta example |
Comments suppressed due to low confidence (3)
phylo/src/phylo_info/phyloinfo_builder.rs:59
- Removing the
sequence_filesetter method breaks the existing builder API; consider deprecating it first or bumping the crate's major version under semantic versioning.
PhyloInfoBuilder {
phylo/src/io/mod.rs:109
- [nitpick] Example doctest writes output into the source-tracked
examples/datadirectory; it may be better to usestd::env::temp_dir()or a dedicated temporary path to avoid choking version control or write-permission issues.
/// let output_path = PathBuf::from("./examples/data/doctest_tmp_output.fasta");
phylo/Cargo.toml:15
- [nitpick] The
excludelist includesbenches/andtarget/, but these directories may not exist in the crate root; consider verifying or removing unused patterns to simplify the manifest.
]
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## develop #70 +/- ##
===========================================
+ Coverage 96.26% 96.65% +0.38%
===========================================
Files 27 30 +3
Lines 3991 4240 +249
===========================================
+ Hits 3842 4098 +256
+ Misses 149 142 -7 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This PR is to reduce the final package size of the crate. It moves small data files used in doctests into the examples/data directory and updates paths to the files. Additionally, it simplifies the
PhyloInfoBuilderclass by removing the redundantsequence_filemethod, as this one file path is the only necessary attribute to create a validPhyloInfo.