Commit a7c83aec2149a4885bfac032859142e8a62bceab

Ben Straub 2013-12-06T13:39:08

Clarify docs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
diff --git a/include/git2/diff.h b/include/git2/diff.h
index 1654523..315cc12 100644
--- a/include/git2/diff.h
+++ b/include/git2/diff.h
@@ -577,9 +577,9 @@ typedef struct {
 	unsigned int version;
 
 	/**
-	 * Combination of git_diff_find_t values (default FIND_BY_CONFIG).  Note
-	 * that if the configuration value is falsy, this will result in
-	 * `git_diff_find_similar` doing nothing. 
+	 * Combination of git_diff_find_t values (default FIND_BY_CONFIG).
+	 * Note that if you don't explicitly set this, `diff.renames` could be set
+	 * to false, resulting in `git_diff_find_similar` doing nothing. 
 	 */
 	uint32_t flags;