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.
This commit is contained in:
Henrik Lissner 2022-07-27 22:30:08 +02:00
parent 5af38fb08e
commit df8caf2867
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
2 changed files with 8 additions and 3 deletions

View file

@ -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)

View file

@ -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: