chore: Add doc comment for DiffOptions.Paths (#63385)

varungandhi-src · web-flow · commit cd4d788f45e8 · 2024-06-20T19:26:34.000+08:00
Was confused on reading some of our code, which is not
setting this value in the way that is expected when attempting
to handle range re-mapping for precise code nav.
diff --git a/internal/gitserver/client.go b/internal/gitserver/client.go
@@ -318,6 +318,10 @@ type DiffOptions struct {
 	// For a nice visual explanation of ".." vs "...", see https://stackoverflow.com/a/46345364/2682729
 	RangeType string
 
+	// Paths specifies the paths to filter for during diffing.
+	//
+	// NOTE: Rename detection does not work if only the old path or the new path
+	// is specified in this slice.
 	Paths []string
 }
 

Original file line number	Diff line number	Diff line change
`@@ -318,6 +318,10 @@ type DiffOptions struct {`
`318`	`318`	`// For a nice visual explanation of ".." vs "...", see https://stackoverflow.com/a/46345364/2682729`
`319`	`319`	`RangeType string`
`320`	`320`
	`321`	`+ // Paths specifies the paths to filter for during diffing.`
	`322`	`+ //`
	`323`	`+ // NOTE: Rename detection does not work if only the old path or the new path`
	`324`	`+ // is specified in this slice.`
`321`	`325`	`Paths []string`
`322`	`326`	`}`
`323`	`327`