Browse Source

Add doc for short option

Takeru Ohta 2 years ago
parent
commit
4c62b3443f
1 changed files with 1 additions and 0 deletions
  1. 1 0
      src/jsone.erl

+ 1 - 0
src/jsone.erl

@@ -137,6 +137,7 @@
 %% `decimals': <br />
 %% - The encoded string will contain at most `Decimals' number of digits past the decimal point. <br />
 %% - If `compact' is provided the trailing zeros at the end of the string are truncated. <br />
+%% - If `short' is provided the float is formatted with the smallest number of digits. <br />
 %%
 %% For more details, see <a href="http://erlang.org/doc/man/erlang.html#float_to_list-2">erlang:float_to_list/2</a>.
 %%