logtree: chase out some documentation typos
Test Plan: only documentation changes.
X-Origin-Diff: phab/D627
GitOrigin-RevId: 78b1983bd67c632f467227689371113f26da5842
diff --git a/core/pkg/logtree/doc.go b/core/pkg/logtree/doc.go
index 5445e2e..caef97a 100644
--- a/core/pkg/logtree/doc.go
+++ b/core/pkg/logtree/doc.go
@@ -28,13 +28,13 @@
Tree Structure
-As an example, consider application that produces logs with the following DNs:
+As an example, consider an application that produces logs with the following DNs:
listener.http
- listener.grpc
- svc
- svc.cache
- svc.cache.gc
+ listener.grpc
+ svc
+ svc.cache
+ svc.cache.gc
This would correspond to a tree as follows:
diff --git a/core/pkg/logtree/journal.go b/core/pkg/logtree/journal.go
index d65a2f4..bffe1b5 100644
--- a/core/pkg/logtree/journal.go
+++ b/core/pkg/logtree/journal.go
@@ -27,7 +27,7 @@
// the root node of the tree.
type DN string
-// Parth return the parts of a DN, ie. all the elements of the dot-delimited DN path. For the root node, an empty list
+// Path return the parts of a DN, ie. all the elements of the dot-delimited DN path. For the root node, an empty list
// will be returned. An error will be returned if the DN is invalid (contains empty parts, eg. `foo..bar`, `.foo` or
// `foo.`.
func (d DN) Path() ([]string, error) {
@@ -180,7 +180,7 @@
}
}
-// getEntries returns all entries at a given DN. This is faster then a scanEntries(filterExact), as it uses the special
+// getEntries returns all entries at a given DN. This is faster than a scanEntries(filterExact), as it uses the special
// local linked list pointers to traverse the journal. Additional filters can be passed to further limit the entries
// returned, but a scan through this DN's local linked list will be performed regardless.
// journal.mu must be taken at R or RW level when calling this function.