diff options
Diffstat (limited to 'doc/lispref')
| -rw-r--r-- | doc/lispref/ChangeLog | 10 | ||||
| -rw-r--r-- | doc/lispref/display.texi | 9 | ||||
| -rw-r--r-- | doc/lispref/sequences.texi | 47 |
3 files changed, 57 insertions, 9 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog index aa4d3200830..3fe3d6fd6a0 100644 --- a/doc/lispref/ChangeLog +++ b/doc/lispref/ChangeLog | |||
| @@ -1,3 +1,13 @@ | |||
| 1 | 2015-02-06 Nicolas Petton <nicolas@petton.fr> | ||
| 2 | |||
| 3 | * sequences.texi (Sequence Functions): Add documentation for | ||
| 4 | seq-mapcat, seq-partition and seq-group-by. | ||
| 5 | |||
| 6 | 2015-02-05 Martin Rudalics <rudalics@gmx.at> | ||
| 7 | |||
| 8 | * display.texi (Size of Displayed Text): Remove description of | ||
| 9 | optional argument BUFFER of `window-text-pixel-size'. | ||
| 10 | |||
| 1 | 2015-02-01 Martin Rudalics <rudalics@gmx.at> | 11 | 2015-02-01 Martin Rudalics <rudalics@gmx.at> |
| 2 | 12 | ||
| 3 | * display.texi (Size of Displayed Text): Describe optional | 13 | * display.texi (Size of Displayed Text): Describe optional |
diff --git a/doc/lispref/display.texi b/doc/lispref/display.texi index 10b17a3f389..b09b82a6724 100644 --- a/doc/lispref/display.texi +++ b/doc/lispref/display.texi | |||
| @@ -1880,7 +1880,7 @@ displayed in a given window. This function is used by | |||
| 1880 | @code{fit-frame-to-buffer} (@pxref{Size and Position}) to make a window | 1880 | @code{fit-frame-to-buffer} (@pxref{Size and Position}) to make a window |
| 1881 | exactly as large as the text it contains. | 1881 | exactly as large as the text it contains. |
| 1882 | 1882 | ||
| 1883 | @defun window-text-pixel-size &optional window from to x-limit y-limit mode-and-header-line buffer | 1883 | @defun window-text-pixel-size &optional window from to x-limit y-limit mode-and-header-line |
| 1884 | This function returns the size of the text of @var{window}'s buffer in | 1884 | This function returns the size of the text of @var{window}'s buffer in |
| 1885 | pixels. @var{window} must be a live window and defaults to the selected | 1885 | pixels. @var{window} must be a live window and defaults to the selected |
| 1886 | one. The return value is a cons of the maximum pixel-width of any text | 1886 | one. The return value is a cons of the maximum pixel-width of any text |
| @@ -1919,13 +1919,6 @@ means to not include the height of the mode- or header-line of | |||
| 1919 | @code{mode-line} or @code{header-line}, include only the height of that | 1919 | @code{mode-line} or @code{header-line}, include only the height of that |
| 1920 | line, if present, in the return value. If it is @code{t}, include the | 1920 | line, if present, in the return value. If it is @code{t}, include the |
| 1921 | height of both, if present, in the return value. | 1921 | height of both, if present, in the return value. |
| 1922 | |||
| 1923 | The optional argument @var{buffer} allows to specify an alternate buffer | ||
| 1924 | whose text size will be calculated. If @var{buffer} is @code{nil} or | ||
| 1925 | omitted, then operate on the buffer of @var{window}. If it is @code{t}, | ||
| 1926 | then operate on the current buffer as if it were displayed in | ||
| 1927 | @var{window}. If it specifies a live buffer, then operate on that | ||
| 1928 | buffer as if it were displayed in @var{window}. | ||
| 1929 | @end defun | 1922 | @end defun |
| 1930 | 1923 | ||
| 1931 | 1924 | ||
diff --git a/doc/lispref/sequences.texi b/doc/lispref/sequences.texi index f82c4962759..f268c0d11e2 100644 --- a/doc/lispref/sequences.texi +++ b/doc/lispref/sequences.texi | |||
| @@ -695,9 +695,54 @@ concatenation of @var{sequences}. @var{type} may be: @code{vector}, | |||
| 695 | @end example | 695 | @end example |
| 696 | @end defun | 696 | @end defun |
| 697 | 697 | ||
| 698 | @defun seq-mapcat function sequence &optional type | ||
| 699 | This function returns the result of applying @code{seq-concatenate} | ||
| 700 | to the result of applying @var{function} to each element of | ||
| 701 | @var{sequence}. The result is a sequence of type @var{type}, or a | ||
| 702 | list if @var{type} is @code{nil}. | ||
| 703 | |||
| 704 | @example | ||
| 705 | @group | ||
| 706 | (seq-mapcat #'seq-reverse '((3 2 1) (6 5 4))) | ||
| 707 | @result{} (1 2 3 4 5 6) | ||
| 708 | @end group | ||
| 709 | @end example | ||
| 710 | @end defun | ||
| 711 | |||
| 712 | @defun seq-partition sequence n | ||
| 713 | This function returns a list of the elements of @var{sequence} | ||
| 714 | grouped into sub-sequences of length @var{n}. The last sequence may | ||
| 715 | contain less elements than @var{n}. @var{n} must be an integer. If | ||
| 716 | @var{n} is a negative integer or 0, nil is returned. | ||
| 717 | |||
| 718 | @example | ||
| 719 | @group | ||
| 720 | (seq-partition '(0 1 2 3 4 5 6 7) 3) | ||
| 721 | @result{} ((0 1 2) (3 4 5) (6 7)) | ||
| 722 | @end group | ||
| 723 | @end example | ||
| 724 | @end defun | ||
| 725 | |||
| 726 | @defun seq-group-by function sequence | ||
| 727 | This function separates the elements of @var{sequence} into an alist | ||
| 728 | whose keys are the result of applying @var{function} to each element | ||
| 729 | of @var{sequence}. Keys are compared using @code{equal}. | ||
| 730 | |||
| 731 | @example | ||
| 732 | @group | ||
| 733 | (seq-group-by #'integerp '(1 2.1 3 2 3.2)) | ||
| 734 | @result{} ((t 2 3 1) (nil 3.2 2.1)) | ||
| 735 | @end group | ||
| 736 | @group | ||
| 737 | (seq-group-by #'car '((a 1) (b 2) (a 3) (c 4))) | ||
| 738 | @result{} ((a (a 3) (a 1)) (b (b 2)) (c (c 4))) | ||
| 739 | @end group | ||
| 740 | @end example | ||
| 741 | @end defun | ||
| 742 | |||
| 698 | @defmac seq-doseq (var sequence [result]) body@dots{} | 743 | @defmac seq-doseq (var sequence [result]) body@dots{} |
| 699 | @cindex sequence iteration | 744 | @cindex sequence iteration |
| 700 | This macro is like @code{dolist}, except that @var{sequence} can be a list, | 745 | This macro is like @code{dolist}, except that @var{sequence} can be a list, |
| 701 | vector or string (@pxref{Iteration} for more information about the | 746 | vector or string (@pxref{Iteration} for more information about the |
| 702 | @code{dolist} macro). This is primarily useful for side-effects. | 747 | @code{dolist} macro). This is primarily useful for side-effects. |
| 703 | @end defmac | 748 | @end defmac |