From 0bd2d363750db35926460cbc4c3e62dcb1d09bf5 Mon Sep 17 00:00:00 2001
From: Robert Hensing <robert@roberthensing.nl>
Date: Wed, 24 Jul 2024 12:53:37 +0200
Subject: [PATCH] Document renderMarkdownToTerminal

---
 src/libcmd/markdown.hh | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/libcmd/markdown.hh b/src/libcmd/markdown.hh
index a04d32a4f..164f99b98 100644
--- a/src/libcmd/markdown.hh
+++ b/src/libcmd/markdown.hh
@@ -5,6 +5,13 @@
 
 namespace nix {
 
+/**
+ * Render the given Markdown text to the terminal.
+ *
+ * If Nix is compiled without Markdown support, this function will return the input text as-is.
+ *
+ * The renderer takes into account the terminal width, and wraps text accordingly.
+ */
 std::string renderMarkdownToTerminal(std::string_view markdown);
 
 }