update comments about internal rep to match reality

This commit is contained in:
alisdair sullivan 2013-10-30 00:57:50 +00:00
parent eb7527e9a3
commit 08673b144e
2 changed files with 6 additions and 2 deletions

View file

@ -132,7 +132,9 @@ indent_or_space(Config) ->
end. end.
%% internal state is a stack of in progress objects/arrays %% internal state is a stack and a config object
%% `{Stack, Config}`
%% the stack is a list of in progress objects/arrays
%% `[Current, Parent, Grandparent,...OriginalAncestor]` %% `[Current, Parent, Grandparent,...OriginalAncestor]`
%% an object has the representation on the stack of %% an object has the representation on the stack of
%% `{object, Object}` %% `{object, Object}`

View file

@ -101,7 +101,9 @@ format_key(Key, Config) ->
end. end.
%% internal state is a stack of in progress objects/arrays %% internal state is a stack and a config object
%% `{Stack, Config}`
%% the stack is a list of in progress objects/arrays
%% `[Current, Parent, Grandparent,...OriginalAncestor]` %% `[Current, Parent, Grandparent,...OriginalAncestor]`
%% an object has the representation on the stack of %% an object has the representation on the stack of
%% `{object, [{NthKey, NthValue}, {NMinus1Key, NthMinus1Value},...{FirstKey, FirstValue}]}` %% `{object, [{NthKey, NthValue}, {NMinus1Key, NthMinus1Value},...{FirstKey, FirstValue}]}`