OneUptime Copilot: Improve Comments on /App/FeatureSet/Docs/Utils/Ren…

…der.ts
OneUptime · Jul 9, 2024 · 294b245 · 294b245
1 parent 3eb3564
commit 294b245
Showing 1 changed file with 5 additions and 1 deletion.
diff --git a/App/FeatureSet/Docs/Utils/Render.ts b/App/FeatureSet/Docs/Utils/Render.ts
@@ -1,7 +1,11 @@
 import Markdown, { MarkdownContentType } from "CommonServer/Types/Markdown";
 
+// This class is responsible for rendering markdown content to HTML
 export default class DocsRender {
+
+  // Render markdown content to HTML and return the result as a promise
   public static async render(markdownContent: string): Promise<string> {
+    // Use the Markdown library to convert markdown content to HTML
     return Markdown.convertToHTML(markdownContent, MarkdownContentType.Docs);
   }
-}
+}