Merge pull request #81 from Dretch/add-stack-safety-note

Add a note to the docs about stack safety and using Data.List.(manyRec|someRec).
purescript-contrib · May 6, 2019 · e801a0e · e801a0e
2 parents 530a81b + 49b585f
commit e801a0e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,5 +5,6 @@
 !/.jshintrc
 !/.travis.yml
 /bower_components/
+/generated-docs/
 /node_modules/
 /output/
diff --git a/src/Text/Parsing/Parser/Combinators.purs b/src/Text/Parsing/Parser/Combinators.purs
@@ -17,6 +17,9 @@
 -- | ```purescript
 -- | Text.Parsec.many  (char 'x') <=> fromCharArray <$> Data.Array.many (char 'x')
 -- | ```
+-- |
+-- | Note that `Data.(Array|List).(many|some)` are not stack safe. If you need to parse
+-- | large numbers of items then consider using `Data.List.(manyRec|someRec)` instead.
 
 module Text.Parsing.Parser.Combinators where