Merge pull request #71 from chrisdaish/master

Updated documentation to include the fail_on_deprecation_notices flag
voxpupuli · Feb 1, 2017 · 495e523 · 495e523
2 parents d4ec821 + cfb0692
commit 495e523
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -97,6 +97,10 @@ If you are trying to validate the syntax of code written for application orchest
 
     PuppetSyntax.app_management = true
 
+Deprecation notices will cause a failure by default, you can override this functionality by setting:
+
+    PuppetSyntax.fail_on_deprecation_notices = false
+
 ## Installation
 
 Add this line to your application's Gemfile: