[elpa] externals/m-buffer 20f5618f2b 061/115: Documentation updates.

[ELPA Syncer]

branch: externals/m-buffer
commit 20f5618f2bc9efd35dfce95553289f8cead709ce
Author: Phillip Lord <phillip.lord@newcastle.ac.uk>
Commit: Phillip Lord <phillip.lord@newcastle.ac.uk>

    Documentation updates.
---
 README.md   |  6 +++++-
 m-buffer.el | 21 +++++++++++++--------
 2 files changed, 18 insertions(+), 9 deletions(-)

diff --git a/README.md b/README.md
index cc4ab2b793..06b2679459 100644
--- a/README.md
+++ b/README.md
@@ -16,7 +16,8 @@ For full commentary, please see [m-buffer.el](m-buffer.el).
 
 ## Status
 
-Early release, all APIs subject to change.
+The code is now in active use. APIs are open to change, but I am not intending
+to.
 
 ## Contributions
 
@@ -28,6 +29,9 @@ with the FSF.
 
 ## Change Log
 
+### 0.7
+ - `m-buffer-match-first-line' added.
+
 ### 0.6
 
  - All match functions now take a :numeric argument which forces the
diff --git a/m-buffer.el b/m-buffer.el
index 3d43710775..47dd489b57 100644
--- a/m-buffer.el
+++ b/m-buffer.el
@@ -1,4 +1,4 @@
-;;; m-buffer.el --- Buffer Manipulation Functions -*- lexical-binding: t -*-
+;;; m-buffer.el --- List-Oriented, Functional Buffer Manipulation -*- 
lexical-binding: t -*-
 
 ;; This file is not part of Emacs
 
@@ -27,13 +27,18 @@
 ;;; Commentary:
 ;;
 ;; This file provides a set of list orientated functions for operating over
-;; the contents of buffers. Functions are generally purish: i.e. they may
-;; change the state of one buffer by side-effect, but should not affect point,
-;; current buffer, match data or so forth. Generally, markers are returned
-;; rather than point locations, so that it is possible for example, to search
-;; for regexp matches, and then replace them all without the early replacement
-;; invalidating the location of the later ones.
-;;
+;; the contents of buffers. They avoid the use of looping, manipulating global
+;; state with `match-data'. Many high-level functions exist for matching
+;; sentences, lines and so on.
+
+;; Functions are generally purish: i.e. they may change the state of one
+;; buffer by side-effect, but should not affect point, current buffer, match
+;; data or so forth. Generally, markers are returned rather than point
+;; locations, so that it is possible for example, to search for regexp
+;; matches, and then replace them all without the early replacement
+;; invalidating the location of the later ones. Some support macros are added
+;; to help dispose of used or unwanted markers to ensure performant code.
+
 
 ;;; Status:
 ;;