From df8caf2867442deec7cbbb7c7be2472d4bc2de10 Mon Sep 17 00:00:00 2001 From: Henrik Lissner Date: Wed, 27 Jul 2022 22:30:08 +0200 Subject: [PATCH] nit(cli): revise header commentary To properly reflect that it's unsafe to load core-cli in interactive sessions, but safe to load core-cli-lib. --- core/core-cli-lib.el | 5 +++++ core/core-cli.el | 6 +++--- 2 files changed, 8 insertions(+), 3 deletions(-) diff --git a/core/core-cli-lib.el b/core/core-cli-lib.el index 937af959c..5eed7b2e4 100644 --- a/core/core-cli-lib.el +++ b/core/core-cli-lib.el @@ -1,5 +1,10 @@ ;;; core/core-cli-lib.el --- API+DSL for Doom's CLI framework -*- lexical-binding: t; -*- ;;; Commentary: +;; +;; The heart of Doom's CLI framework. This is safe to load in interactive +;; sessions (for API access and syntax highlighting), but much of the API +;; expects a noninteractive session, so take care when testing code! +;; ;;; Code: (require 'seq) diff --git a/core/core-cli.el b/core/core-cli.el index 0d12ad4f2..a83fb43bc 100644 --- a/core/core-cli.el +++ b/core/core-cli.el @@ -1,9 +1,9 @@ ;;; core/core-cli.el --- The heart of Doom's CLI framework -*- lexical-binding: t; no-byte-compile: t; -*- ;;; Commentary: ;; -;; The heart of Doom's CLI framework. This is safe to load in interactive -;; sessions (for API access and syntax highlighting), but much of the API -;; expects a noninteractive session, so take care when testing code! +;; The bootstrapper for Doom's CLI. This is *not* safe to load in interactive +;; sessions as it has many side-effects. Loads `core-cli-lib' instead for API +;; access and syntax highlighting. ;; ;;; Code: