add documentation for `side_effects` & `[#@]__PURE__` (#1925)
authorolsonpm <olsonpm@users.noreply.github.com>
Fri, 12 May 2017 04:29:55 +0000 (23:29 -0500)
committerAlex Lam S.L <alexlamsl@gmail.com>
Fri, 12 May 2017 04:29:55 +0000 (12:29 +0800)
README.md

index c50a8ec..205395f 100644 (file)
--- a/README.md
+++ b/README.md
@@ -409,6 +409,11 @@ to set `true`; it's effectively a shortcut for `foo=true`).
 - `keep_infinity` -- default `false`. Pass `true` to prevent `Infinity` from
   being compressed into `1/0`, which may cause performance issues on Chrome.
 
+- `side_effects` -- default `false`. Pass `true` to potentially drop functions
+marked as "pure".  (A function is marked as "pure" via the comment annotation
+`/* @__PURE__ */` or `/* #__PURE__ */`)
+
+
 ### The `unsafe` option
 
 It enables some transformations that *might* break code logic in certain