Merge pull request #1556 from OneUptime/oneuptime-app-oneuptime-app-i…

…mprove-comments-csMvV [OneUptime Copilot] Improve Comments on /App/FeatureSet/Docs/Utils/Render.ts
OneUptime · Jul 9, 2024 · 0990ef0 · 0990ef0
2 parents 3eb3564 + 294b245
commit 0990ef0
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);
   }
-}
+}