Skip to content

test: Redo doctest: TableCollection::new_from_file #272

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

Merged
merged 1 commit into from
Jul 18, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 3 additions & 20 deletions src/table_collection.rs
Original file line number Diff line number Diff line change
Expand Up @@ -133,32 +133,15 @@ impl TableCollection {
/// # let empty_tables = tskit::TableCollection::new(100.).unwrap();
/// # empty_tables.dump("trees.file", tskit::TableOutputOptions::default()).unwrap();
/// let tables = tskit::TableCollection::new_from_file("trees.file").unwrap();
/// # std::fs::remove_file("trees.file").unwrap();
/// ```
///
/// ```
/// # let empty_tables = tskit::TableCollection::new(100.).unwrap();
/// # empty_tables.dump("trees.file", tskit::TableOutputOptions::default()).unwrap();
/// let filename = String::from("trees.file");
/// // Move filename
/// let tables = tskit::TableCollection::new_from_file(filename).unwrap();
/// # std::fs::remove_file("trees.file").unwrap();
/// ```
///
/// ```
/// # let empty_tables = tskit::TableCollection::new(100.).unwrap();
/// # empty_tables.dump("trees.file", tskit::TableOutputOptions::default()).unwrap();
/// let filename = String::from("trees.file");
/// // Pass filename by reference
/// let tables = tskit::TableCollection::new_from_file(&filename).unwrap();
/// # std::fs::remove_file("trees.file").unwrap();
/// ```
///
/// Boxed `String`s are an unlikely use case, but can be made to work:
/// // Move filename
/// let tables = tskit::TableCollection::new_from_file(filename).unwrap();
///
/// ```
/// # let empty_tables = tskit::TableCollection::new(100.).unwrap();
/// # empty_tables.dump("trees.file", tskit::TableOutputOptions::default()).unwrap();
/// // Boxed String are an unlikely use case, but can be made to work:
/// let filename = Box::new(String::from("trees.file"));
/// let tables = tskit::TableCollection::new_from_file(&*filename.as_ref()).unwrap();
/// # std::fs::remove_file("trees.file").unwrap();
Expand Down