Data.List.isSubsequenceOf documentation clarification
authorJustin Raymond <justin.raymond.14@gmail.com>
Mon, 16 Nov 2015 16:05:36 +0000 (17:05 +0100)
committerBen Gamari <ben@smart-cactus.org>
Mon, 16 Nov 2015 20:59:47 +0000 (21:59 +0100)
Fixes #11083.

Reviewers: austin, hvr, bgamari

Reviewed By: bgamari

Subscribers: thomie

Differential Revision: https://phabricator.haskell.org/D1477

GHC Trac Issues: #11083

libraries/base/Data/List.hs

index ab85cf4..693c0dd 100644 (file)
@@ -219,8 +219,9 @@ import Data.OldList hiding ( all, and, any, concat, concatMap, elem, find,
 
 import GHC.Base ( Bool(..), Eq((==)), otherwise )
 
--- | The 'isSubsequenceOf' function takes two lists and returns 'True' if the
--- first list is a subsequence of the second list.
+-- | The 'isSubsequenceOf' function takes two lists and returns 'True' if all
+-- the elements of the first list occur, in order, in the second. The
+-- elements do not have to occur consecutively.
 --
 -- @'isSubsequenceOf' x y@ is equivalent to @'elem' x ('subsequences' y)@.
 --