Document incompatibility of global state with memoization

mna / pigeon

Command pigeon generates parsers in Go from a PEG grammar.

BSD 3-Clause "New" or "Revised" License

823 stars 66 forks source link

Document incompatibility of global state with memoization #55

Open breml opened 6 years ago

breml commented 6 years ago

Update documentation to reflect the incompatibility of global state with memoization.

see https://github.com/mna/pigeon/pull/52#issuecomment-340592275

breml commented 6 years ago

Additionally to the updated documentation in doc.go, a warning could be raised by pigeon if a grammar with global state is used with memoization enabled or the memoization feature could be replaced with a no-op to prevent the usage of global state with memoization. Could be combined with #57.