From: Alexandre Terrasa <alexandre@moz-code.org>
Date: Wed, 10 Dec 2014 23:39:04 +0000 (-0500)
Subject: src/pretty: add usage example in DocUnit
X-Git-Tag: v0.7~63^2
X-Git-Url: http://nitlanguage.org

src/pretty: add usage example in DocUnit

Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>
---

diff --git a/src/pretty.nit b/src/pretty.nit
index a99f3a6..75d9879 100644
--- a/src/pretty.nit
+++ b/src/pretty.nit
@@ -14,6 +14,18 @@
 
 # Library used to pretty print Nit code.
 #
+# Usage:
+#
+#     import parser_util
+#     var tc = new ToolContext
+#     var nmodule = tc.parse_something("class A\nfun   toto :  Int  do   return   5\nend")
+#     var ppv = new PrettyPrinterVisitor
+#     var pmodule = ppv.pretty(nmodule)
+#     assert pmodule.write_to_string == """
+#     class A
+#     \tfun toto: Int do return 5
+#     end"""
+#
 # See `nitpretty` tool for more documentation.
 module pretty