Clarify the use of `exwm-config-default'

* exwm-config.el (exwm-config-example): Renamed from `exwm-config-default' to make it clear it's just an example.
ch11ng · May 10, 2020 · 624a302 · 624a302
1 parent 7f4b9cd
commit 624a302
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/exwm-config.el b/exwm-config.el
@@ -28,7 +28,10 @@
 (require 'exwm)
 (require 'ido)
 
-(defun exwm-config-default ()
+(define-obsolete-function-alias 'exwm-config-default
+  #'exwm-config-example "27.1")
+
+(defun exwm-config-example ()
   "Default configuration of EXWM."
   ;; Set the initial workspace number.
   (unless (get 'exwm-workspace-number 'saved-value)

diff --git a/exwm.el b/exwm.el
@@ -46,7 +46,7 @@
 ;;
 ;;    (require 'exwm)
 ;;    (require 'exwm-config)
-;;    (exwm-config-default)
+;;    (exwm-config-example)
 ;;
 ;; 3. Link or copy the file 'xinitrc' to '~/.xinitrc'.
 ;; 4. Launch EXWM in a console (e.g. tty1) with