Update src/features/changeForwarding.ts

Co-authored-by: Joey Robichaud <[email protected]>

Author: 333fred

src/features/changeForwarding.ts

@@ -50,9 +50,12 @@ function forwardFileChanges(server: OmniSharpServer): IDisposable {
             }
 
             if (changeType === FileChangeType.Change && uri.fsPath.endsWith(".cs")) {
-                // The server watches for file system events from .cs files, if we send
-                // a file changed event as well it will cause a double-apply and potentially
-                // invalidate the file state
+                // When a file changes on disk a FileSystemEvent is generated as well as
+                // a DidChangeTextDocumentEvent. The OmniSharp server listens for Change events
+                // for ".cs" files and reloads their text from disk. This creates a situation where the server
+                // may have updated the document to reflect disk and also recieves a set of TextChanges
+                // to apply to the document. In order to avoid that situation, we will not send Change events
+                // for ".cs" files and instead allow them to be updated via the DidChangeTextDocumentEvent.
                 return;
             }