[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/dash de5ff6a 037/439: Simplify quotes in readme.
From: |
Phillip Lord |
Subject: |
[elpa] externals/dash de5ff6a 037/439: Simplify quotes in readme. |
Date: |
Tue, 04 Aug 2015 20:26:07 +0000 |
branch: externals/dash
commit de5ff6af38536e01147620af4db6112e64eec83f
Author: Magnar Sveen <address@hidden>
Commit: Magnar Sveen <address@hidden>
Simplify quotes in readme.
---
README.md | 68 +++++++++++++++++++++++++-------------------------
examples-to-docs.el | 14 +++++++++-
2 files changed, 47 insertions(+), 35 deletions(-)
diff --git a/README.md b/README.md
index 7bea548..b90fb85 100644
--- a/README.md
+++ b/README.md
@@ -58,9 +58,9 @@ instead of one.
Returns a new list consisting of the result of applying `fn` to the items in
`list`.
```cl
-(!map (lambda (num) (* num num)) (quote (1 2 3 4))) ;; => (quote (1 4 9 16))
-(!map (quote square) (quote (1 2 3 4))) ;; => (quote (1 4 9 16))
-(!!map (* it it) (quote (1 2 3 4))) ;; => (quote (1 4 9 16))
+(!map (lambda (num) (* num num)) '(1 2 3 4)) ;; => '(1 4 9 16)
+(!map 'square '(1 2 3 4)) ;; => '(1 4 9 16)
+(!!map (* it it) '(1 2 3 4)) ;; => '(1 4 9 16)
```
### !reduce-from `(fn initial-value list)`
@@ -71,9 +71,9 @@ item, etc. If `list` contains no items, returns
`initial-value` and
`fn` is not called.
```cl
-(!reduce-from (quote +) 7 (quote (1 2))) ;; => 10
-(!reduce-from (lambda (memo item) (+ memo item)) 7 (quote (1 2))) ;; => 10
-(!!reduce-from (+ acc it) 7 (quote (1 2 3))) ;; => 13
+(!reduce-from '+ 7 '(1 2)) ;; => 10
+(!reduce-from (lambda (memo item) (+ memo item)) 7 '(1 2)) ;; => 10
+(!!reduce-from (+ acc it) 7 '(1 2 3)) ;; => 13
```
### !reduce `(fn list)`
@@ -85,9 +85,9 @@ reduce returns the result of calling `fn` with no arguments.
If
`list` has only 1 item, it is returned and `fn` is not called.
```cl
-(!reduce (quote +) (quote (1 2))) ;; => 3
-(!reduce (lambda (memo item) (format %s-%s memo item)) (quote (1 2 3))) ;; =>
1-2-3
-(!!reduce (format %s-%s acc it) (quote (1 2 3))) ;; => 1-2-3
+(!reduce '+ '(1 2)) ;; => 3
+(!reduce (lambda (memo item) (format %s-%s memo item)) '(1 2 3)) ;; => 1-2-3
+(!!reduce (format %s-%s acc it) '(1 2 3)) ;; => 1-2-3
```
### !filter `(fn list)`
@@ -95,9 +95,9 @@ reduce returns the result of calling `fn` with no arguments.
If
Returns a new list of the items in `list` for which `fn` returns a non-nil
value.
```cl
-(!filter (lambda (num) (= 0 (% num 2))) (quote (1 2 3 4))) ;; => (quote (2 4))
-(!filter (quote even?) (quote (1 2 3 4))) ;; => (quote (2 4))
-(!!filter (= 0 (% it 2)) (quote (1 2 3 4))) ;; => (quote (2 4))
+(!filter (lambda (num) (= 0 (% num 2))) '(1 2 3 4)) ;; => '(2 4)
+(!filter 'even? '(1 2 3 4)) ;; => '(2 4)
+(!!filter (= 0 (% it 2)) '(1 2 3 4)) ;; => '(2 4)
```
### !remove `(fn list)`
@@ -105,9 +105,9 @@ Returns a new list of the items in `list` for which `fn`
returns a non-nil value
Returns a new list of the items in `list` for which `fn` returns nil.
```cl
-(!remove (lambda (num) (= 0 (% num 2))) (quote (1 2 3 4))) ;; => (quote (1 3))
-(!remove (quote even?) (quote (1 2 3 4))) ;; => (quote (1 3))
-(!!remove (= 0 (% it 2)) (quote (1 2 3 4))) ;; => (quote (1 3))
+(!remove (lambda (num) (= 0 (% num 2))) '(1 2 3 4)) ;; => '(1 3)
+(!remove 'even? '(1 2 3 4)) ;; => '(1 3)
+(!!remove (= 0 (% it 2)) '(1 2 3 4)) ;; => '(1 3)
```
### !concat `(&rest lists)`
@@ -116,9 +116,9 @@ Returns a new list with the concatenation of the elements in
the supplied `lists`.
```cl
-(!concat (quote (1))) ;; => (quote (1))
-(!concat (quote (1)) (quote (2))) ;; => (quote (1 2))
-(!concat (quote (1)) (quote (2 3)) (quote (4))) ;; => (quote (1 2 3 4))
+(!concat '(1)) ;; => '(1)
+(!concat '(1) '(2)) ;; => '(1 2)
+(!concat '(1) '(2 3) '(4)) ;; => '(1 2 3 4)
```
### !mapcat `(fn list)`
@@ -127,9 +127,9 @@ Returns the result of applying concat to the result of
applying map to `fn` and
Thus function `fn` should return a collection.
```cl
-(!mapcat (quote list) (quote (1 2 3))) ;; => (quote (1 2 3))
-(!mapcat (lambda (item) (list 0 item)) (quote (1 2 3))) ;; => (quote (0 1 0 2
0 3))
-(!!mapcat (list 0 it) (quote (1 2 3))) ;; => (quote (0 1 0 2 0 3))
+(!mapcat 'list '(1 2 3)) ;; => '(1 2 3)
+(!mapcat (lambda (item) (list 0 item)) '(1 2 3)) ;; => '(0 1 0 2 0 3)
+(!!mapcat (list 0 it) '(1 2 3)) ;; => '(0 1 0 2 0 3)
```
### !partial `(fn &rest args)`
@@ -140,8 +140,8 @@ When called, the returned function calls `fn` with args +
additional args.
```cl
-(funcall (!partial (quote +) 5) 3) ;; => 8
-(funcall (!partial (quote +) 5 2) 3) ;; => 10
+(funcall (!partial '+ 5) 3) ;; => 8
+(funcall (!partial '+ 5 2) 3) ;; => 10
```
### !difference `(list list2)`
@@ -151,9 +151,9 @@ The test for equality is done with `equal`,
or with `!compare-fn` if that's non-nil.
```cl
-(!difference (quote nil) (quote nil)) ;; => (quote nil)
-(!difference (quote (1 2 3)) (quote (4 5 6))) ;; => (quote (1 2 3))
-(!difference (quote (1 2 3 4)) (quote (3 4 5 6))) ;; => (quote (1 2))
+(!difference 'nil 'nil) ;; => 'nil
+(!difference '(1 2 3) '(4 5 6)) ;; => '(1 2 3)
+(!difference '(1 2 3 4) '(3 4 5 6)) ;; => '(1 2)
```
### !intersection `(list list2)`
@@ -163,9 +163,9 @@ The test for equality is done with `equal`,
or with `!compare-fn` if that's non-nil.
```cl
-(!intersection (quote nil) (quote nil)) ;; => (quote nil)
-(!intersection (quote (1 2 3)) (quote (4 5 6))) ;; => (quote nil)
-(!intersection (quote (1 2 3 4)) (quote (3 4 5 6))) ;; => (quote (3 4))
+(!intersection 'nil 'nil) ;; => 'nil
+(!intersection '(1 2 3) '(4 5 6)) ;; => 'nil
+(!intersection '(1 2 3 4) '(3 4 5 6)) ;; => '(3 4)
```
### !uniq `(list)`
@@ -175,8 +175,8 @@ The test for equality is done with `equal`,
or with `!compare-fn` if that's non-nil.
```cl
-(!uniq (quote nil)) ;; => (quote nil)
-(!uniq (quote (1 2 2 4))) ;; => (quote (1 2 4))
+(!uniq 'nil) ;; => 'nil
+(!uniq '(1 2 2 4)) ;; => '(1 2 4)
```
### !contains? `(list element)`
@@ -186,9 +186,9 @@ The test for equality is done with `equal`,
or with `!compare-fn` if that's non-nil.
```cl
-(!contains? (quote (1 2 3)) 1) ;; => t
-(!contains? (quote (1 2 3)) 2) ;; => t
-(!contains? (quote (1 2 3)) 4) ;; => nil
+(!contains? '(1 2 3) 1) ;; => t
+(!contains? '(1 2 3) 2) ;; => t
+(!contains? '(1 2 3) 4) ;; => nil
```
## License
diff --git a/examples-to-docs.el b/examples-to-docs.el
index ac6cd9d..04bc329 100644
--- a/examples-to-docs.el
+++ b/examples-to-docs.el
@@ -44,6 +44,17 @@
(signature (cadr function)))
(format "%s %s" command-name signature)))
+(defun simplify-quotes ()
+ (goto-char (point-min))
+ (while (search-forward "(quote " nil t)
+ (forward-char -7)
+ (let ((p (point)))
+ (forward-sexp 1)
+ (delete-char -1)
+ (goto-char p)
+ (delete-char 7)
+ (insert "'"))))
+
(defun create-docs-file ()
(let ((functions (nreverse functions)))
(with-temp-file "./README.md"
@@ -66,7 +77,8 @@ instead of one.")
(newline 2)
(insert (mapconcat 'function-to-md functions "\n"))
(newline)
- (insert-file-contents-literally "./readme-postfix.md"))))
+ (insert-file-contents-literally "./readme-postfix.md")
+ (simplify-quotes))))
(defun three-first (list)
(let (first)
- [elpa] externals/dash d2dfb11 023/439: Use double-bang for anaphoric functions, (continued)
- [elpa] externals/dash d2dfb11 023/439: Use double-bang for anaphoric functions, Phillip Lord, 2015/08/04
- [elpa] externals/dash 85016d3 029/439: Fix quoted forms like `' in docs., Phillip Lord, 2015/08/04
- [elpa] externals/dash 6f0636f 032/439: Show only three first examples per function., Phillip Lord, 2015/08/04
- [elpa] externals/dash 4cc4147 035/439: Fix typo, Phillip Lord, 2015/08/04
- [elpa] externals/dash 41d77ec 034/439: Add function list to readme., Phillip Lord, 2015/08/04
- [elpa] externals/dash 214a7db 030/439: Quote and lowercase parameter names in docstring., Phillip Lord, 2015/08/04
- [elpa] externals/dash ec27b47 025/439: Turn tests into examples that can both be tested and turned into docs, Phillip Lord, 2015/08/04
- [elpa] externals/dash 1997e52 031/439: Treat dashes in docstring better., Phillip Lord, 2015/08/04
- [elpa] externals/dash 78fc2a3 038/439: Quote and downcase params with digits in them too., Phillip Lord, 2015/08/04
- [elpa] externals/dash 06efd3c 039/439: Slight improvements to docs., Phillip Lord, 2015/08/04
- [elpa] externals/dash de5ff6a 037/439: Simplify quotes in readme.,
Phillip Lord <=
- [elpa] externals/dash 5f6ea16 036/439: Fix typo, Phillip Lord, 2015/08/04
- [elpa] externals/dash 722fea6 033/439: Include docs in README, Phillip Lord, 2015/08/04
- [elpa] externals/dash 657ee8b 040/439: Slight improvements to docs., Phillip Lord, 2015/08/04
- [elpa] externals/dash 26113a1 041/439: Add pre-commit.sh that runs tests and updates readme., Phillip Lord, 2015/08/04
- [elpa] externals/dash e7d5c01 043/439: Add note about README being autogenerated to Development notes., Phillip Lord, 2015/08/04
- [elpa] externals/dash 32053cd 042/439: Update readme with development notes., Phillip Lord, 2015/08/04
- [elpa] externals/dash e1a362c 047/439: Update README to reflect changes in readme generation., Phillip Lord, 2015/08/04
- [elpa] externals/dash 1b0d54f 044/439: Simplify readme generation., Phillip Lord, 2015/08/04
- [elpa] externals/dash eea3c53 045/439: Move function list above anaphoric function description., Phillip Lord, 2015/08/04
- [elpa] externals/dash 2a9e600 046/439: Make functions paragraph into a list of links, Phillip Lord, 2015/08/04