From 90b16ad7f79da8535686061518aba60cd520dd92 Mon Sep 17 00:00:00 2001
From: cage <cage@invalid>
Date: Sun, 13 Nov 2022 16:19:13 +0100
Subject: [PATCH] - added docstring for 'status-tree->text'.

---
 src/ui-goodies.lisp | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/ui-goodies.lisp b/src/ui-goodies.lisp
index e53c731..6894afd 100644
--- a/src/ui-goodies.lisp
+++ b/src/ui-goodies.lisp
@@ -953,6 +953,11 @@ If some posts was deleted before, download them again."
   (expand-status-tree t))
 
 (defun status-tree->text ()
+  "Convert  a thread  to  a text  representation, if  a  file path  is
+provided will  be created,  with the  thread's content,  otherwise the
+text will be printed on the main window.
+
+It an existing file path is provided the command will refuse to run."
   (let* ((thread "")
          (message-max-width (truncate (/ (win-width-no-border *message-window*) 3)))
          (padding-step      (truncate (/ message-max-width 4))))