emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[nongnu] elpa/j-mode 50b6ad1 13/56: Updating doc strings


From: ELPA Syncer
Subject: [nongnu] elpa/j-mode 50b6ad1 13/56: Updating doc strings
Date: Sun, 29 Aug 2021 11:20:45 -0400 (EDT)

branch: elpa/j-mode
commit 50b6ad19cbe4703f55b33cec1d0506a5499d70a6
Author: Zachary Elliott <zach@nyu.edu>
Commit: Zachary Elliott <zach@nyu.edu>

    Updating doc strings
---
 j-console.el   | 14 ++++++++------
 j-font-lock.el |  6 ++++--
 j-mode.el      |  9 +++++----
 3 files changed, 17 insertions(+), 12 deletions(-)

diff --git a/j-console.el b/j-console.el
index d17a7f2..aa0f1ed 100644
--- a/j-console.el
+++ b/j-console.el
@@ -58,7 +58,9 @@
 
 (defcustom j-console-cmd-init-file nil
   "Full path to the file who's contents are sent to the
-  j-console-cmd on start"
+  j-console-cmd on start
+
+Should be NIL if there is no file not the empty string"
   :type 'string
   :group 'j-console)
 
@@ -68,13 +70,13 @@
   :group 'j-console)
 
 (defvar j-console-comint-input-filter-function nil
-  "")
+  "J mode specific mask for comint input filter function")
 
 (defvar j-console-comint-output-filter-function nil
-  "")
+  "J mode specific mask for comint output filter function")
 
 (defvar j-console-comint-preoutput-filter-function nil
-  "")
+  "J mode specific mask for comint preoutput filter function")
 
 ;; 'comint-preoutput-filter-functions
 ;; (lambda ( output )
@@ -83,7 +85,7 @@
 ;;     output))))
 
 (defun j-console-create-session ()
-  "Starts a comint session"
+  "Starts a comint session wrapped around the j-console-cmd"
   (setq comint-process-echoes t)
   (apply 'make-comint j-console-cmd-buffer-name
          j-console-cmd j-console-cmd-init-file j-console-cmd-args)
@@ -109,7 +111,7 @@
 
 ;;;###autoload
 (defun j-console ()
-  "Ensure a running j-console-cmd session and switches focus to
+  "Ensures a running j-console-cmd session and switches focus to
 the containing buffer"
   (interactive)
   (switch-to-buffer-other-window (process-buffer (j-console-ensure-session))))
diff --git a/j-font-lock.el b/j-font-lock.el
index 30c16a4..a37fd27 100644
--- a/j-font-lock.el
+++ b/j-font-lock.el
@@ -42,9 +42,11 @@
   :group 'j
   :prefix "j-font-lock-")
 
+
 (defgroup j-faces nil
-  "Faces for j-mode font-lock"
-  :group 'j-)
+  "Faces for j-font-lock"
+  :group 'j
+  :group 'j-font-lock)
 
 (defmacro build-faces ( &rest faces )
   "Allows for easy defining of multiple faces in one command.
diff --git a/j-mode.el b/j-mode.el
index 4596e93..ffb5439 100644
--- a/j-mode.el
+++ b/j-mode.el
@@ -5,7 +5,7 @@
 ;;
 ;; Authors: Zachary Elliott <ZacharyElliott1@gmail.com>
 ;; URL: http://github.com/zellio/j-mode
-;; Version: 0.1.0
+;; Version: 0.1.1
 ;; Keywords: J, Langauges
 
 ;; This file is not part of GNU Emacs.
@@ -38,7 +38,7 @@
 (require 'j-help)
 
 
-(defconst j-mode-version "0.1.0"
+(defconst j-mode-version "0.1.1"
   "`j-mode' version")
 
 (defgroup j-mode nil
@@ -47,7 +47,7 @@
   :prefix "j-")
 
 (defcustom j-mode-hook nil
-  "Hook called by `j-mode'."
+  "Hook called by `j-mode'"
   :type 'hook
   :group 'j)
 
@@ -76,7 +76,7 @@
 
 ;;;###autoload
 (defun j-mode ()
-  "Major mode for editing J code"
+  "Major mode for editing J"
   (interactive)
   (kill-all-local-variables)
   (use-local-map j-mode-map)
@@ -99,6 +99,7 @@
 
 ;;;###autoload
 (progn
+  ;; adding j files to the auot-mode-alist
   (add-to-list 'auto-mode-alist '("\\.ij[rstp]$" . j-mode)))
 
 (provide 'j-mode)



reply via email to

[Prev in Thread] Current Thread [Next in Thread]