Skip to content

Commit

Permalink
Update dyland and dime commentary
Browse files Browse the repository at this point in the history
These go into the package descriptions for MELPA, so the commentary in
a package's main source file should describe the whole package to
people who are interested in installing it.
  • Loading branch information
lassik committed Mar 20, 2021
1 parent c51cdb2 commit a916e28
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 18 deletions.
27 changes: 13 additions & 14 deletions dime.el
Original file line number Diff line number Diff line change
Expand Up @@ -18,26 +18,25 @@

;;; Commentary:

;; This file contains extensions for programming in Open Dylan.
;; The main features are:
;; Dime is the Dylan interaction mode for Emacs. It is essentially an
;; IDE (integrated development environment) for the Dylan programming
;; language and the Open Dylan toolchain.

;; * A socket-based communication/RPC interface between Emacs and
;; Dylan, enabling introspection and remote development.
;; The main features are:

;; * The `dime-mode' minor-mode complementing `dylan-mode'. This new
;; mode includes many commands for interacting with the Open Dylan
;; process.
;; * The `dime-mode' minor-mode. It augments `dylan-mode' with many
;; commands for interacting with Open Dylan.

;; * A Dylan debugger written in Emacs Lisp. The debugger pops up
;; an Emacs buffer similar to the Emacs/Elisp debugger.
;; * The ability to display compiler messages directly at their source
;; code locations.

;; * A Open Dylan inspector to interactively look at run-time data.
;; * A debugger running in Emacs, similar to the Emacs Lisp debugger.

;; * Trapping compiler messages and creating annotations in the source
;; file on the appropriate forms.
;; * An inspector to interactively look at run-time data.

;; In order to run Dime, a supporting Dylan server called Swank is
;; required.
;; Dime works by opening a socket between Emacs and Open Dylan and
;; communicating via the dswank protocol. Dime traces its history back
;; to SLIME (the Superior Lisp Interaction Mode for Emacs).

;;; Code:

Expand Down
12 changes: 8 additions & 4 deletions dylan.el
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,14 @@

;;; Commentary:

;; Dylan mode is a major mode for editing Dylan programs. It provides
;; indenting and syntax highlighting support.
;; This package provides three Emacs modes for the Dylan programming
;; language:

;; * The `dylan-mode` major mode to edit Dylan code.
;; * The `dylan-opt-mode` minor mode to show compiler optimizations.
;; * The `dylan-lid-mode` major mode to edit LID files.

;;; Code:

;; Testing
;;
Expand All @@ -41,8 +47,6 @@
;; their values, frequently the easiest way to test changes is to start a new
;; Emacs.

;;; Code:

;;; Customization:

(defgroup dylan nil
Expand Down

0 comments on commit a916e28

Please sign in to comment.