From e5078e9337603b46ea259bbbb64f4b58d1c47ca6 Mon Sep 17 00:00:00 2001
From: Mark Wiemer <markwiemer@outlook.com>
Date: Mon, 28 Oct 2024 20:05:55 -0700
Subject: [PATCH] Document Out class

---
 src/common/out.ts | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/common/out.ts b/src/common/out.ts
index 56d185ea..a6b7aabf 100644
--- a/src/common/out.ts
+++ b/src/common/out.ts
@@ -4,6 +4,10 @@ import * as vscode from 'vscode';
 export class Out {
     private static outputChannel: vscode.OutputChannel;
 
+    /**
+     * Logs the given value without focusing the output view.
+     * Prepends all logs with `new Date().toISOString()`.
+     */
     public static debug(value: Error | string) {
         Out.log(value, false);
     }
@@ -12,6 +16,7 @@ export class Out {
      * Logs the given value. Traces errors to console before logging.
      * Prepends all logs with `new Date().toISOString()`.
      * @param value The value to log
+     * @param focus whether to focus the output view. Defaults to true.
      */
     public static log(value: Error | string, focus = true) {
         if (value instanceof Error) {