( )⚙ D5414 rust: improved docstring

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5414

rust: improved docstring
ClosedPublic

Authored by gracinet on Dec 12 2018, 10:11 AM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGdc38d976ff4d: rust: improved docstring
rHGceb695c3c154: rust: improved docstring
Summary

In the previous wording, rustfmt wanted to cut at the == which is not very
readable in my taste.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Revision Contents
Changeset List

PathPackages
Mrust/hg-core/src/ancestors.rs (6 lines)

Diff 12827

rust/hg-core/src/ancestors.rs

/// Main implementation. /// Main implementation.
/// ///
/// The algorithm is the same as in `_lazyancestorsiter()` from `ancestors.py` /// The algorithm is the same as in `_lazyancestorsiter()` from `ancestors.py`
/// with a few non crucial differences: /// with a few non crucial differences:
/// ///
/// - there's no filtering of invalid parent revisions. Actually, it should be /// - there's no filtering of invalid parent revisions. Actually, it should be
/// consistent and more efficient to filter them from the end caller. /// consistent and more efficient to filter them from the end caller.
/// - we don't have the optimization for adjacent revs /// - we don't have the optimization for adjacent revisions (i.e., the case
/// (case where p1 == rev-1), because it amounts to update the first element /// where `p1 == rev - 1`), because it amounts to update the first element of
/// of the heap without sifting, which Rust's BinaryHeap doesn't let us do. /// the heap without sifting, which Rust's BinaryHeap doesn't let us do.
/// - we save a few pushes by comparing with `stoprev` before pushing /// - we save a few pushes by comparing with `stoprev` before pushing
impl<G: Graph> Iterator for AncestorsIterator<G> { impl<G: Graph> Iterator for AncestorsIterator<G> {
type Item = Result<Revision, GraphError>; type Item = Result<Revision, GraphError>;
fn next(&mut self) -> Option<Self::Item> { fn next(&mut self) -> Option<Self::Item> {
let current = match self.visit.peek() { let current = match self.visit.peek() {
None => { None => {
return None; return None;