Merge pull request #237 from Wilfred/add-see-also

Add 'see also' for -select and -remove
9 years ago · 8ef32875da
parent 3493fc97cf e9b861154e
commit 8ef32875da
4 changed files with 197 additions and 185 deletions
--- a/README.md
+++ b/README.md
@ -460,7 +460,7 @@ Return a new list of the items in `list` for which `pred` returns a non-nil valu

 Alias: `-select`

-See also: [`-keep`](#-keep-fn-list)
+See also: [`-keep`](#-keep-fn-list), [`-remove`](#-remove-pred-list).

 ```el
 (-filter (lambda (num) (= 0 (% num 2))) '(1 2 3 4)) ;; => '(2 4)
@ -474,6 +474,8 @@ Return a new list of the items in `list` for which `pred` returns nil.

 Alias: `-reject`

+See also: [`-filter`](#-filter-pred-list).
+
 ```el
 (-remove (lambda (num) (= 0 (% num 2))) '(1 2 3 4)) ;; => '(1 3)
 (-remove 'even? '(1 2 3 4)) ;; => '(1 3)
--- a/dash.el
+++ b/dash.el
@ -236,7 +236,9 @@ See also: `-reduce-r-from', `-reduce'"
  `(-reduce-r (lambda (&optional it acc) ,form) ,list))

 (defmacro --filter (form list)
-  "Anaphoric form of `-filter'."
+  "Anaphoric form of `-filter'.
+
+See also: `--remove'."
  (declare (debug (form form)))
  (let ((r (make-symbol "result")))
    `(let (,r)
@ -248,21 +250,25 @@ See also: `-reduce-r-from', `-reduce'"

 Alias: `-select'

-See also: `-keep'"
+See also: `-keep', `-remove'."
  (--filter (funcall pred it) list))

 (defalias '-select '-filter)
 (defalias '--select '--filter)

 (defmacro --remove (form list)
-  "Anaphoric form of `-remove'."
+  "Anaphoric form of `-remove'.
+
+See also `--filter'."
  (declare (debug (form form)))
  `(--filter (not ,form) ,list))

 (defun -remove (pred list)
  "Return a new list of the items in LIST for which PRED returns nil.

-Alias: `-reject'"
+Alias: `-reject'
+
+See also: `-filter'."
  (--remove (funcall pred it) list))

 (defalias '-reject '-remove)
--- a/dash.info
+++ b/dash.info
@ -341,7 +341,7 @@ Functions returning a sublist of the original list.

     Alias: ‘-select’

-     See also: ‘-keep’ (*note -keep::)
+     See also: ‘-keep’ (*note -keep::), ‘-remove’ (*note -remove::).

          (-filter (lambda (num) (= 0 (% num 2))) '(1 2 3 4))
              ⇒ '(2 4)
@ -356,6 +356,8 @@ Functions returning a sublist of the original list.

     Alias: ‘-reject’

+     See also: ‘-filter’ (*note -filter::).
+
          (-remove (lambda (num) (= 0 (% num 2))) '(1 2 3 4))
              ⇒ '(1 3)
          (-remove 'even? '(1 2 3 4))
@ -2732,9 +2734,9 @@ Index
 * -distinct:                             Set operations.    (line  62)
 * -dotimes:                              Side-effects.      (line  41)
 * -doto:                                 Side-effects.      (line  50)
-* -drop:                                 Sublist selection. (line 123)
-* -drop-last:                            Sublist selection. (line 135)
-* -drop-while:                           Sublist selection. (line 156)
+* -drop:                                 Sublist selection. (line 125)
+* -drop-last:                            Sublist selection. (line 137)
+* -drop-while:                           Sublist selection. (line 158)
 * -each:                                 Side-effects.      (line   8)
 * -each-indexed:                         Side-effects.      (line  28)
 * -each-while:                           Side-effects.      (line  19)
@ -2795,7 +2797,7 @@ Index
 * -max-by:                               Reductions.        (line 151)
 * -min:                                  Reductions.        (line 117)
 * -min-by:                               Reductions.        (line 127)
-* -non-nil:                              Sublist selection. (line  78)
+* -non-nil:                              Sublist selection. (line  80)
 * -none?:                                Predicates.        (line  30)
 * -not:                                  Function combinators.
                                                            (line 119)
@ -2830,9 +2832,9 @@ Index
 * -remove:                               Sublist selection. (line  23)
 * -remove-at:                            List to list.      (line 146)
 * -remove-at-indices:                    List to list.      (line 159)
-* -remove-first:                         Sublist selection. (line  36)
-* -remove-item:                          Sublist selection. (line  66)
-* -remove-last:                          Sublist selection. (line  51)
+* -remove-first:                         Sublist selection. (line  38)
+* -remove-item:                          Sublist selection. (line  68)
+* -remove-last:                          Sublist selection. (line  53)
 * -repeat:                               Other list operations.
                                                            (line  17)
 * -replace:                              List to list.      (line  67)
@ -2844,11 +2846,11 @@ Index
 * -rpartial:                             Function combinators.
                                                            (line  20)
 * -same-items?:                          Predicates.        (line  72)
-* -select-by-indices:                    Sublist selection. (line 167)
-* -select-column:                        Sublist selection. (line 197)
-* -select-columns:                       Sublist selection. (line 178)
+* -select-by-indices:                    Sublist selection. (line 169)
+* -select-column:                        Sublist selection. (line 199)
+* -select-columns:                       Sublist selection. (line 180)
 * -separate:                             Partitioning.      (line  63)
-* -slice:                                Sublist selection. (line  84)
+* -slice:                                Sublist selection. (line  86)
 * -snoc:                                 Other list operations.
                                                            (line  42)
 * -some:                                 Other list operations.
@ -2869,9 +2871,9 @@ Index
                                                            (line 161)
 * -table-flat:                           Other list operations.
                                                            (line 180)
-* -take:                                 Sublist selection. (line 100)
-* -take-last:                            Sublist selection. (line 111)
-* -take-while:                           Sublist selection. (line 145)
+* -take:                                 Sublist selection. (line 102)
+* -take-last:                            Sublist selection. (line 113)
+* -take-while:                           Sublist selection. (line 147)
 * -tree-map:                             Tree operations.   (line  28)
 * -tree-map-nodes:                       Tree operations.   (line  39)
 * -tree-mapreduce:                       Tree operations.   (line  85)
@ -2914,170 +2916,170 @@ Ref: -mapcat9342
 Ref: -copy9718
 Node: Sublist selection9922
 Ref: -filter10115
-Ref: -remove10533
-Ref: -remove-first10895
-Ref: -remove-last11422
-Ref: -remove-item11943
-Ref: -non-nil12337
-Ref: -slice12496
-Ref: -take13028
-Ref: -take-last13336
-Ref: -drop13659
-Ref: -drop-last13932
-Ref: -take-while14192
-Ref: -drop-while14542
-Ref: -select-by-indices14898
-Ref: -select-columns15412
-Ref: -select-column16117
-Node: List to list16580
-Ref: -keep16772
-Ref: -concat17275
-Ref: -flatten17572
-Ref: -flatten-n18331
-Ref: -replace18718
-Ref: -replace-first19181
-Ref: -replace-last19677
-Ref: -insert-at20166
-Ref: -replace-at20493
-Ref: -update-at20888
-Ref: -remove-at21379
-Ref: -remove-at-indices21867
-Node: Reductions22449
-Ref: -reduce-from22618
-Ref: -reduce-r-from23404
-Ref: -reduce24189
-Ref: -reduce-r24997
-Ref: -count25913
-Ref: -sum26137
-Ref: -product26326
-Ref: -min26535
-Ref: -min-by26761
-Ref: -max27284
-Ref: -max-by27509
-Node: Unfolding28037
-Ref: -iterate28276
-Ref: -unfold28721
-Node: Predicates29529
-Ref: -any?29653
-Ref: -all?29973
-Ref: -none?30303
-Ref: -only-some?30605
-Ref: -contains?31090
-Ref: -same-items?31479
-Ref: -is-prefix?31864
-Ref: -is-suffix?32187
-Ref: -is-infix?32510
-Node: Partitioning32864
-Ref: -split-at33052
-Ref: -split-with33337
-Ref: -split-on33740
-Ref: -split-when34416
-Ref: -separate35056
-Ref: -partition35498
-Ref: -partition-all35950
-Ref: -partition-in-steps36378
-Ref: -partition-all-in-steps36875
-Ref: -partition-by37360
-Ref: -partition-by-header37742
-Ref: -partition-after-pred38346
-Ref: -partition-before-pred38717
-Ref: -partition-before-item39095
-Ref: -partition-after-item39406
-Ref: -group-by39712
-Node: Indexing40149
-Ref: -elem-index40351
-Ref: -elem-indices40746
-Ref: -find-index41129
-Ref: -find-last-index41618
-Ref: -find-indices42122
-Ref: -grade-up42530
-Ref: -grade-down42933
-Node: Set operations43343
-Ref: -union43526
-Ref: -difference43968
-Ref: -intersection44385
-Ref: -powerset44822
-Ref: -permutations45035
-Ref: -distinct45335
-Node: Other list operations45659
-Ref: -rotate45884
-Ref: -repeat46179
-Ref: -cons*46442
-Ref: -snoc46829
-Ref: -interpose47242
-Ref: -interleave47540
-Ref: -zip-with47909
-Ref: -zip48626
-Ref: -zip-fill49432
-Ref: -unzip49755
-Ref: -cycle50289
-Ref: -pad50662
-Ref: -table50985
-Ref: -table-flat51775
-Ref: -first52784
-Ref: -some53156
-Ref: -last53465
-Ref: -first-item53799
-Ref: -last-item54112
-Ref: -butlast54404
-Ref: -sort54651
-Ref: -list55139
-Ref: -fix55470
-Node: Tree operations56010
-Ref: -tree-seq56206
-Ref: -tree-map57064
-Ref: -tree-map-nodes57507
-Ref: -tree-reduce58362
-Ref: -tree-reduce-from59244
-Ref: -tree-mapreduce59845
-Ref: -tree-mapreduce-from60705
-Ref: -clone61991
-Node: Threading macros62319
-Ref: ->62464
-Ref: ->>62956
-Ref: -->63461
-Ref: -as->64022
-Ref: -some->64477
-Ref: -some->>64851
-Ref: -some-->65287
-Node: Binding65758
-Ref: -when-let65970
-Ref: -when-let*66455
-Ref: -if-let66983
-Ref: -if-let*67378
-Ref: -let67995
-Ref: -let*72788
-Ref: -lambda73729
-Node: Side-effects74531
-Ref: -each74725
-Ref: -each-while75132
-Ref: -each-indexed75492
-Ref: -dotimes76010
-Ref: -doto76313
-Node: Destructive operations76740
-Ref: !cons76913
-Ref: !cdr77119
-Node: Function combinators77314
-Ref: -partial77588
-Ref: -rpartial77983
-Ref: -juxt78385
-Ref: -compose78817
-Ref: -applify79375
-Ref: -on79822
-Ref: -flip80345
-Ref: -const80657
-Ref: -cut81001
-Ref: -not81487
-Ref: -orfn81797
-Ref: -andfn82231
-Ref: -iteratefn82726
-Ref: -fixfn83429
-Ref: -prodfn84998
-Node: Development86064
-Node: Contribute86413
-Node: Changes87161
-Node: Contributors90160
-Node: Index91784
+Ref: -remove10567
+Ref: -remove-first10978
+Ref: -remove-last11505
+Ref: -remove-item12026
+Ref: -non-nil12420
+Ref: -slice12579
+Ref: -take13111
+Ref: -take-last13419
+Ref: -drop13742
+Ref: -drop-last14015
+Ref: -take-while14275
+Ref: -drop-while14625
+Ref: -select-by-indices14981
+Ref: -select-columns15495
+Ref: -select-column16200
+Node: List to list16663
+Ref: -keep16855
+Ref: -concat17358
+Ref: -flatten17655
+Ref: -flatten-n18414
+Ref: -replace18801
+Ref: -replace-first19264
+Ref: -replace-last19760
+Ref: -insert-at20249
+Ref: -replace-at20576
+Ref: -update-at20971
+Ref: -remove-at21462
+Ref: -remove-at-indices21950
+Node: Reductions22532
+Ref: -reduce-from22701
+Ref: -reduce-r-from23487
+Ref: -reduce24272
+Ref: -reduce-r25080
+Ref: -count25996
+Ref: -sum26220
+Ref: -product26409
+Ref: -min26618
+Ref: -min-by26844
+Ref: -max27367
+Ref: -max-by27592
+Node: Unfolding28120
+Ref: -iterate28359
+Ref: -unfold28804
+Node: Predicates29612
+Ref: -any?29736
+Ref: -all?30056
+Ref: -none?30386
+Ref: -only-some?30688
+Ref: -contains?31173
+Ref: -same-items?31562
+Ref: -is-prefix?31947
+Ref: -is-suffix?32270
+Ref: -is-infix?32593
+Node: Partitioning32947
+Ref: -split-at33135
+Ref: -split-with33420
+Ref: -split-on33823
+Ref: -split-when34499
+Ref: -separate35139
+Ref: -partition35581
+Ref: -partition-all36033
+Ref: -partition-in-steps36461
+Ref: -partition-all-in-steps36958
+Ref: -partition-by37443
+Ref: -partition-by-header37825
+Ref: -partition-after-pred38429
+Ref: -partition-before-pred38800
+Ref: -partition-before-item39178
+Ref: -partition-after-item39489
+Ref: -group-by39795
+Node: Indexing40232
+Ref: -elem-index40434
+Ref: -elem-indices40829
+Ref: -find-index41212
+Ref: -find-last-index41701
+Ref: -find-indices42205
+Ref: -grade-up42613
+Ref: -grade-down43016
+Node: Set operations43426
+Ref: -union43609
+Ref: -difference44051
+Ref: -intersection44468
+Ref: -powerset44905
+Ref: -permutations45118
+Ref: -distinct45418
+Node: Other list operations45742
+Ref: -rotate45967
+Ref: -repeat46262
+Ref: -cons*46525
+Ref: -snoc46912
+Ref: -interpose47325
+Ref: -interleave47623
+Ref: -zip-with47992
+Ref: -zip48709
+Ref: -zip-fill49515
+Ref: -unzip49838
+Ref: -cycle50372
+Ref: -pad50745
+Ref: -table51068
+Ref: -table-flat51858
+Ref: -first52867
+Ref: -some53239
+Ref: -last53548
+Ref: -first-item53882
+Ref: -last-item54195
+Ref: -butlast54487
+Ref: -sort54734
+Ref: -list55222
+Ref: -fix55553
+Node: Tree operations56093
+Ref: -tree-seq56289
+Ref: -tree-map57147
+Ref: -tree-map-nodes57590
+Ref: -tree-reduce58445
+Ref: -tree-reduce-from59327
+Ref: -tree-mapreduce59928
+Ref: -tree-mapreduce-from60788
+Ref: -clone62074
+Node: Threading macros62402
+Ref: ->62547
+Ref: ->>63039
+Ref: -->63544
+Ref: -as->64105
+Ref: -some->64560
+Ref: -some->>64934
+Ref: -some-->65370
+Node: Binding65841
+Ref: -when-let66053
+Ref: -when-let*66538
+Ref: -if-let67066
+Ref: -if-let*67461
+Ref: -let68078
+Ref: -let*72871
+Ref: -lambda73812
+Node: Side-effects74614
+Ref: -each74808
+Ref: -each-while75215
+Ref: -each-indexed75575
+Ref: -dotimes76093
+Ref: -doto76396
+Node: Destructive operations76823
+Ref: !cons76996
+Ref: !cdr77202
+Node: Function combinators77397
+Ref: -partial77671
+Ref: -rpartial78066
+Ref: -juxt78468
+Ref: -compose78900
+Ref: -applify79458
+Ref: -on79905
+Ref: -flip80428
+Ref: -const80740
+Ref: -cut81084
+Ref: -not81570
+Ref: -orfn81880
+Ref: -andfn82314
+Ref: -iteratefn82809
+Ref: -fixfn83512
+Ref: -prodfn85081
+Node: Development86147
+Node: Contribute86496
+Node: Changes87244
+Node: Contributors90243
+Node: Index91867

 End Tag Table

--- a/dash.texi
+++ b/dash.texi
@ -438,7 +438,7 @@ Return a new list of the items in @var{list} for which @var{pred} returns a non-

 Alias: @code{-select}

-See also: @code{-keep} (@pxref{-keep})
+See also: @code{-keep} (@pxref{-keep}), @code{-remove} (@pxref{-remove}).

@example
@group
@ -462,6 +462,8 @@ Return a new list of the items in @var{list} for which @var{pred} returns nil.

 Alias: @code{-reject}

+See also: @code{-filter} (@pxref{-filter}).
+
@example
@group
 (-remove (lambda (num) (= 0 (% num 2))) '(1 2 3 4))