From 21011964daabe7b92118a803add41afbe9b92f64 Mon Sep 17 00:00:00 2001
From: alisdair sullivan <alisdairsullivan@yahoo.ca>
Date: Tue, 22 Jan 2013 12:41:56 -0800
Subject: [PATCH] add `{incomplete, ...}` to return types of core jsx functions

`encode`, `decode`, `format`, `prettify` and `minify` were incompletely specified

closes #27
---
 src/jsx.erl | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)

diff --git a/src/jsx.erl b/src/jsx.erl
index 7285566..b4eb526 100644
--- a/src/jsx.erl
+++ b/src/jsx.erl
@@ -52,8 +52,8 @@
 -type json_text() :: binary().
 
 
--spec encode(Source::json_term()) -> json_text().
--spec encode(Source::json_term(), Opts::jsx_to_json:opts()) -> json_text().
+-spec encode(Source::json_term()) -> json_text() | {incomplete, encoder()}.
+-spec encode(Source::json_term(), Opts::jsx_to_json:opts()) -> json_text() | {incomplete, encoder()}.
 
 encode(Source) -> encode(Source, []).
 encode(Source, Opts) -> jsx_to_json:to_json(Source, Opts).
@@ -66,25 +66,25 @@ term_to_json(Source) -> encode(Source, []).
 term_to_json(Source, Opts) -> encode(Source, Opts).
 
 
--spec format(Source::json_text()) -> json_text().
--spec format(Source::json_text(), Opts::jsx_to_json:opts()) -> json_text().
+-spec format(Source::json_text()) -> json_text() | {incomplete, decoder()}.
+-spec format(Source::json_text(), Opts::jsx_to_json:opts()) -> json_text() | {incomplete, decoder()}.
 
 format(Source) -> format(Source, []).
 format(Source, Opts) -> jsx_to_json:format(Source, Opts).
 
 
--spec minify(Source::json_text()) -> json_text().
+-spec minify(Source::json_text()) -> json_text()  | {incomplete, decoder()}.
 
 minify(Source) -> format(Source, []).
 
 
--spec prettify(Source::json_text()) -> json_text().
+-spec prettify(Source::json_text()) -> json_text() | {incomplete, decoder()}.
 
 prettify(Source) -> format(Source, [space, {indent, 2}]).
 
 
--spec decode(Source::json_text()) -> json_term().
--spec decode(Source::json_text(), Opts::jsx_to_term:opts()) -> json_term().
+-spec decode(Source::json_text()) -> json_term() | {incomplete, decoder()}.
+-spec decode(Source::json_text(), Opts::jsx_to_term:opts()) -> json_term()  | {incomplete, decoder()}.
 
 decode(Source) -> decode(Source, []).
 decode(Source, Opts) -> jsx_to_term:to_term(Source, Opts).