flatmap docstring fixes, NEWS (#44905)

JuliaLang · Apr 14, 2022 · c0c7194 · c0c7194
1 parent 6319b3a
commit c0c7194
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/NEWS.md b/NEWS.md
@@ -36,6 +36,8 @@ Build system changes
 New library functions
 ---------------------
 
+* `Iterators.flatmap` was added ([#44792]).
+
 Library changes
 ---------------
 

diff --git a/base/iterators.jl b/base/iterators.jl
@@ -1167,6 +1167,11 @@ last(f::Flatten) = last(last(f.it))
 
 Equivalent to `flatten(map(f, iterators...))`.
 
+See also [`Iterators.flatten`](@ref), [`Iterators.map`](@ref).
+
+!!! compat "Julia 1.9"
+    This function was added in Julia 1.9.
+
 # Examples
 ```jldoctest
 julia> Iterators.flatmap(n->-n:2:n, 1:3) |> collect
@@ -1182,7 +1187,6 @@ julia> Iterators.flatmap(n->-n:2:n, 1:3) |> collect
   3
 ```
 """
-# flatmap = flatten ∘ map
 flatmap(f, c...) = flatten(map(f, c...))
 
 """

diff --git a/doc/src/base/iterators.md b/doc/src/base/iterators.md
@@ -14,6 +14,7 @@ Base.Iterators.cycle
 Base.Iterators.repeated
 Base.Iterators.product
 Base.Iterators.flatten
+Base.Iterators.flatmap
 Base.Iterators.partition
 Base.Iterators.map
 Base.Iterators.filter
-Original file line number
+Diff line change
@@ Expand Up / @@ -36,6 +36,8 @@ Build system changes @@
     New library functions
     ---------------------
+    * `Iterators.flatmap` was added ([#44792]).
     Library changes
     ---------------
@@ Expand Down @@