branch: externals/dash
commit 330cc0ddcc11749dcfdff52047a7bb99d5271ecf
Author: Basil L. Contovounesios <[email protected]>
Commit: Basil L. Contovounesios <[email protected]>
Tweak Commentary and Markdown
For discussion, see:
https://lists.gnu.org/r/emacs-devel/2026-02/msg00540.html
* dash.el: Tweak recent Commentary to restore original lede and
reference to README.md.
* NEWS.md:
* readme-template.md: Prefer curved quotes in Markdown.
* README.md: Regenerate docs.
---
NEWS.md | 2 +-
README.md | 8 ++++----
dash.el | 28 +++++++++++++++-------------
readme-template.md | 8 ++++----
4 files changed, 24 insertions(+), 22 deletions(-)
diff --git a/NEWS.md b/NEWS.md
index 21f9f905b1..9375c5cda7 100644
--- a/NEWS.md
+++ b/NEWS.md
@@ -254,7 +254,7 @@ This release retired Emacs 23 support.
- Added `-cycle`, `-pad`, `-annotate`, and `-zip-fill` (Steve Lamb).
- Added `-table`, `-table-flat` (finite Cartesian product).
- Added `-flatten-n`.
-- `-slice` now supports a "step" argument.
+- `-slice` now supports a “step” argument.
- Added functional combinators `-iteratefn` and `-prodfn`.
- Added `-replace`, `-splice`, and `-splice-list` which generalize
`-replace-at`
and `-insert-at`.
diff --git a/README.md b/README.md
index 34ce3ac8fa..5b3b4e9100 100644
--- a/README.md
+++ b/README.md
@@ -41,7 +41,7 @@
Libraries")`](https://gnu.org/software/emacs/manual/html_node/emacs/Lisp-Librari
### Using in a package
-Add something like this to the library's headers:
+Add something like this to the library’s headers:
;; Package-Requires: ((dash "2.20.0"))
@@ -3287,10 +3287,10 @@ This function satisfies the following laws:
## Contribute
Yes, please do. Pure functions in the list manipulation realm only,
-please. There's a suite of examples/tests in `dev/examples.el`, so
+please. There’s a suite of examples/tests in `dev/examples.el`, so
remember to add tests for your additions, or I might break them later.
-You'll find the repo at:
+You’ll find the repo at:
https://github.com/magnars/dash.el
@@ -3307,7 +3307,7 @@ that the tests are always running and the docs are always
in sync:
cp dev/pre-commit.sh .git/hooks/pre-commit
-Oh, and don't edit `README.md` or `dash.texi` directly; they are
+Oh, and don’t edit `README.md` or `dash.texi` directly; they are
auto-generated. Change `readme-template.md` or `dash-template.texi`
instead, respectively.
diff --git a/dash.el b/dash.el
index b4feee43a5..ea7fece5a5 100644
--- a/dash.el
+++ b/dash.el
@@ -24,19 +24,21 @@
;;; Commentary:
-;; Dash is a library implementing utility functions to help fascilitate
-;; Clojure-style functional programming patterns, such as providing
-;; various higher-order functions (map, reduce, filter, ...) and derived
-;; functionality (drop, flatten, sum, ...), functional combinators
-;; (partial application, argument flipping, composition, ...) and
-;; threading and anaphoric macros with destructuring support.
-
-;; Dash is commonly used to provide a common baseline for consistent
-;; functions, which is especially useful for packages that want to
-;; support older releases of Emacs.
-
-;; For further details please consult the Info node `(dash) Top' or read
-;; the manual via the WWW: https://elpa.gnu.org/packages/doc/dash.html.
+;; A modern list API for Emacs.
+;;
+;; Dash is a utility library that affords functional programming
+;; patterns inspired by Clojure, particularly in the realm of list
+;; manipulation. Examples include higher-order functions (map, reduce,
+;; filter) and derivatives (drop, flatten, sum); function combinators
+;; (partial application, argument flipping, composition); and threading
+;; and anaphoric macros with destructuring support.
+;;
+;; Dash is particularly useful in providing a broad and consistent API
+;; across many Emacs versions.
+;;
+;; Documentation and examples are in the manual at Info node `(dash) Top'
+;; and on the web at https://elpa.gnu.org/packages/doc/dash.html, as well
+;; as in the project’s README.md file.
;;; Code:
diff --git a/readme-template.md b/readme-template.md
index 380943928f..ec45dfdd15 100644
--- a/readme-template.md
+++ b/readme-template.md
@@ -41,7 +41,7 @@
Libraries")`](https://gnu.org/software/emacs/manual/html_node/emacs/Lisp-Librari
### Using in a package
-Add something like this to the library's headers:
+Add something like this to the library’s headers:
;; Package-Requires: ((dash "[[ dash-version ]]"))
@@ -113,10 +113,10 @@ This demonstrates the utility of both versions.
## Contribute
Yes, please do. Pure functions in the list manipulation realm only,
-please. There's a suite of examples/tests in `dev/examples.el`, so
+please. There’s a suite of examples/tests in `dev/examples.el`, so
remember to add tests for your additions, or I might break them later.
-You'll find the repo at:
+You’ll find the repo at:
https://github.com/magnars/dash.el
@@ -133,7 +133,7 @@ that the tests are always running and the docs are always
in sync:
cp dev/pre-commit.sh .git/hooks/pre-commit
-Oh, and don't edit `README.md` or `dash.texi` directly; they are
+Oh, and don’t edit `README.md` or `dash.texi` directly; they are
auto-generated. Change `readme-template.md` or `dash-template.texi`
instead, respectively.
