From 0f254bb343074ae69b3e14963ffe1cc4c23ceae7 Mon Sep 17 00:00:00 2001 From: Kamal Marhubi Date: Mon, 1 Feb 2016 12:55:12 -0500 Subject: [PATCH] docs: Clarify return type of lookup_project_file --- src/bin/rustfmt.rs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/bin/rustfmt.rs b/src/bin/rustfmt.rs index 3bd575bfe87..14cb63db7d5 100644 --- 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> { let mut current = if dir.is_relative() { try!(env::current_dir()).join(dir)