docs: Clarify return type of lookup_project_file

2016-02-01 12:55:12 -05:00 · 2016-02-01 12:55:12 -05:00 · 0f254bb343
commit 0f254bb343
parent 98726d0a53
1 changed files with 2 additions and 1 deletions
--- a/src/bin/rustfmt.rs
+++ b/src/bin/rustfmt.rs
@ -43,7 +43,8 @@ enum Operation {
    Stdin(String, WriteMode),
 }

-/// Try to find a project file in the given directory and its parents.
+/// Try to find a project file in the given directory and its parents. Returns the path of a the
+/// nearest project file if one exists, or `None` if no project file was found.
 fn lookup_project_file(dir: &Path) -> io::Result<Option<PathBuf>> {
    let mut current = if dir.is_relative() {
        try!(env::current_dir()).join(dir)