org-tag-eldoc-common.el

   1 ;;; org-tag-eldoc-common.el --- common functions for org-tag-eldoc -*- lexical-binding: t; -*-
   2 ;; -*- coding: utf-8 -*-
   3
   4 ;; Copyright (C) 2024-2025 Christopher M. Miles, all rights reserved.
   5
   6 ;;; Commentary:
   7
   8
   9
  10 ;;; Code:
  11 \f
  12 (defvar org-tag-eldoc--explanation nil
  13   "A private variable to store the function internal variable `explanation'.")
  14
  15 (defun org-tag-eldoc-common--format-explanation (text)
  16   "Format TEXT for better displaying."
  17   (require 'subr-x)
  18   (if text
  19       (thread-last
  20         text
  21         (string-clean-whitespace)
  22         ;; (string-replace "\n" "")
  23         )
  24     (error "[org-tag-eldoc] `org-tag-eldoc-common--format-explanation' argument `TEXT' is `nil'")))
  25
  26 \f
  27
  28 (provide 'org-tag-eldoc-common)
  29
  30 ;;; org-tag-eldoc-common.el ends here