From: Marius Gavrilescu <marius@ieval.ro>
Date: Sat, 28 Apr 2018 16:38:05 +0000 (+0300)
Subject: Slightly better doc
X-Git-Tag: 0.005001~1
X-Git-Url: http://git.ieval.ro/?a=commitdiff_plain;h=b3270ee0b26603ccc6f98c0275da427b98b8fe1b;p=app-scheme79asm.git

Slightly better doc
---

diff --git a/lib/App/Scheme79asm/Compiler.pm b/lib/App/Scheme79asm/Compiler.pm
index 417707f..de1ca05 100644
--- a/lib/App/Scheme79asm/Compiler.pm
+++ b/lib/App/Scheme79asm/Compiler.pm
@@ -241,8 +241,15 @@ L<App::Scheme79asm> wants it to be.
 The two main methods are B<compile_sexp>(I<$sexp>) which compiles an
 already-parsed sexp to assembly format, and
 B<compile_string>(I<$string>) which compiles a string to assembly
-format. The assembly format is a L<Data::SExpression> object that can
-be passed to App::Scheme79asm->B<process>.
+format.
+
+The assembly format is a sexp. These functions return an
+already-parsed sexp (an arrayref like the ones returned by
+L<Data::SExpression>'s B<read> method). This arrayref can be passed
+directly to L<App::Scheme79asm>'s B<process> method.
+
+If a string representation of the sexp is required, it can be obtained
+by calling the B<dump_sexp> function in L<Data::Dump::Sexp> with such an arrayref.
 
 =head1 AUTHOR