dag: minor updates on iddag docstring

Summary: Make the docstring a bit more consistent.

Reviewed By: andll

Differential Revision: D29363798

fbshipit-source-id: 1b4e2a7a1af4c4cffe3693e437a831bab1b43fd7
This commit is contained in:
Jun Wu 2021-06-24 14:59:06 -07:00 committed by Facebook GitHub Bot
parent 7ed94dde6a
commit 77e8dcc21d
2 changed files with 4 additions and 2 deletions

View File

@ -68,7 +68,7 @@ impl PreparedFlatSegments {
self.segments.extend(rhs.segments);
}
/// Return list of all (unique) parents + head of this flat segments list
/// Return list of all (unique) parents + head of this flat segments list.
pub fn parents_and_head(&self) -> BTreeSet<Id> {
let mut s: BTreeSet<Id> = self
.segments

View File

@ -545,7 +545,8 @@ impl<Store: IdDagStore> IdDag<Store> {
Ok(PreparedFlatSegments { segments })
}
/// return all flat segments that overlaps with range (and potentially cover larger range then supplied)
/// Return all flat segments that overlap with range (and potentially cover
/// larger range than supplied).
fn flat_segments_range(&self, min: Id, max_incl: Id) -> Result<Vec<FlatSegment>> {
let level = 0;
let mut segments = Vec::new();
@ -565,6 +566,7 @@ impl<Store: IdDagStore> IdDag<Store> {
Ok(segments)
}
/// Extract flat segments that cover the given `set` exactly.
pub fn idset_to_flat_segments(&self, set: IdSet) -> Result<PreparedFlatSegments> {
let mut segments = Vec::new();