docs: Clarify return type of lookup_project_file

kamalmarhubi · kamalmarhubi · commit 0f254bb34307 · 2016-02-01T12:55:12.000-05:00
diff --git 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)

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,8 @@ enum Operation {`
`43`	`43`	`Stdin(String, WriteMode),`
`44`	`44`	`}`
`45`	`45`
`46`		`-/// Try to find a project file in the given directory and its parents.`
	`46`	`+/// Try to find a project file in the given directory and its parents. Returns the path of a the`
	`47`	+/// nearest project file if one exists, or `None` if no project file was found.
`47`	`48`	`fn lookup_project_file(dir: &Path) -> io::Result<Option<PathBuf>> {`
`48`	`49`	`let mut current = if dir.is_relative() {`
`49`	`50`	`try!(env::current_dir()).join(dir)`