diff options
| author | Chong Yidong | 2012-02-17 22:01:05 +0800 |
|---|---|---|
| committer | Chong Yidong | 2012-02-17 22:01:05 +0800 |
| commit | 7b926f3f3db5d9a22260209547fb3e60df919ecf (patch) | |
| tree | 7728b5c424cb28deb71a90afe24b9eaa89320a5c /doc | |
| parent | ee0ce425dbd94d9b15c1442f9699a47b7feeaf90 (diff) | |
| download | emacs-7b926f3f3db5d9a22260209547fb3e60df919ecf.tar.gz emacs-7b926f3f3db5d9a22260209547fb3e60df919ecf.zip | |
Clarify doc of scan-lists.
* doc/lispref/syntax.texi (Motion via Parsing): Doc fix for scan-lists.
* src/syntax.c (Fscan_lists): Doc fix.
Fixes: debbugs:10833
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/lispref/ChangeLog | 4 | ||||
| -rw-r--r-- | doc/lispref/syntax.texi | 30 |
2 files changed, 19 insertions, 15 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index ab01544c453..85e78abdc32 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,7 @@ | |||
| 1 | 2012-02-17 Chong Yidong <cyd@gnu.org> | ||
| 2 | |||
| 3 | * syntax.texi (Motion via Parsing): Doc fix for scan-lists. | ||
| 4 | |||
| 1 | 2012-02-17 Glenn Morris <rgm@gnu.org> | 5 | 2012-02-17 Glenn Morris <rgm@gnu.org> |
| 2 | 6 | ||
| 3 | * hooks.texi (Standard Hooks): Fix cross-ref to Emacs manual. | 7 | * hooks.texi (Standard Hooks): Fix cross-ref to Emacs manual. |
diff --git a/doc/lispref/syntax.texi b/doc/lispref/syntax.texi index dbfa4ca9045..e2fb3238642 100644 --- a/doc/lispref/syntax.texi +++ b/doc/lispref/syntax.texi | |||
| @@ -646,25 +646,25 @@ result, Emacs treats them as four consecutive empty string constants. | |||
| 646 | based on parsing expressions. | 646 | based on parsing expressions. |
| 647 | 647 | ||
| 648 | @defun scan-lists from count depth | 648 | @defun scan-lists from count depth |
| 649 | This function scans forward @var{count} balanced parenthetical groupings | 649 | This function scans forward @var{count} balanced parenthetical |
| 650 | from position @var{from}. It returns the position where the scan stops. | 650 | groupings from position @var{from}. It returns the position where the |
| 651 | If @var{count} is negative, the scan moves backwards. | 651 | scan stops. If @var{count} is negative, the scan moves backwards. |
| 652 | 652 | ||
| 653 | If @var{depth} is nonzero, assume that the starting point is already | 653 | If @var{depth} is nonzero, treat the starting position as being |
| 654 | @var{depth} parentheses deep. This function counts out @var{count} | 654 | @var{depth} parentheses deep. The scanner moves forward or backward |
| 655 | number of points where the parenthesis depth goes back to zero, then | 655 | through the buffer until the depth changes to zero @var{count} times. |
| 656 | stops. Thus, a positive value for @var{depth} has the effect of | 656 | Hence, a positive value for @var{depth} has the effect of moving out |
| 657 | moving out @var{depth} levels of parenthesis, whereas a negative | 657 | @var{depth} levels of parenthesis from the starting position, while a |
| 658 | @var{depth} has the effect of moving deeper by @var{-depth} levels of | 658 | negative @var{depth} has the effect of moving deeper by @var{-depth} |
| 659 | parenthesis. | 659 | levels of parenthesis. |
| 660 | 660 | ||
| 661 | Scanning ignores comments if @code{parse-sexp-ignore-comments} is | 661 | Scanning ignores comments if @code{parse-sexp-ignore-comments} is |
| 662 | non-@code{nil}. | 662 | non-@code{nil}. |
| 663 | 663 | ||
| 664 | If the scan reaches the beginning or end of the buffer (or its | 664 | If the scan reaches the beginning or end of the accessible part of the |
| 665 | accessible portion), and the depth is not zero, an error is signaled. | 665 | buffer before it has scanned over @var{count} parenthetical groupings, |
| 666 | If the depth is zero but the count is not used up, @code{nil} is | 666 | the return value is @code{nil} if the depth at that point is zero; if |
| 667 | returned. | 667 | the depth is non-zero, a @code{scan-error} error is signaled. |
| 668 | @end defun | 668 | @end defun |
| 669 | 669 | ||
| 670 | @defun scan-sexps from count | 670 | @defun scan-sexps from count |