From 130346570aaf157e4660c946d6c17ce93fd439c2 Mon Sep 17 00:00:00 2001
From: Matt <85322+mattmassicotte@users.noreply.github.com>
Date: Sun, 8 Sep 2024 08:09:19 -0400
Subject: [PATCH] Some details on TreeSitterClient and how it fits in

---
 Sources/TreeSitterClient/TreeSitterClient.swift | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/Sources/TreeSitterClient/TreeSitterClient.swift b/Sources/TreeSitterClient/TreeSitterClient.swift
index da18072..147d2e2 100644
--- a/Sources/TreeSitterClient/TreeSitterClient.swift
+++ b/Sources/TreeSitterClient/TreeSitterClient.swift
@@ -12,6 +12,11 @@ enum TreeSitterClientError: Error {
 	case languageUnavailable(String)
 }
 
+/// Interface with the tree-sitter parsing query system.
+///
+/// TreeSitterClient supports arbitrary language nesting and unified queries across the document.
+///
+/// Tree-sitter ultimately resolves to a single semantic view of the text, and is considered a single phase. However, it may require numerous validation/invalidation passes before fully resolving a document's content.
 @MainActor
 public final class TreeSitterClient {
 	public typealias TextProvider = SwiftTreeSitter.Predicate.TextProvider