search

willemdj / erlsom

XML parser for Erlang
GNU Lesser General Public License v3.0
264 stars 103 forks source link

fix erlsom:write/3 documentation #55

Closed zuckschwerdt closed 8 years ago

zuckschwerdt commented 8 years ago

fix erlsom:write/3 documentation from charlist to chardata as expected by erlsom_write:write/3.

(I'd say the return will always be a genuine charlist, but it's a subset of chardata and chardata is more common in the erlang methods and docs.)

willemdj commented 8 years ago

Maybe you are right that chardata is more common, but it is in fact a charlist. That means that it is always a list, never a binary. I think this is relevant information, and I don't see any real value in replacing it by something that is less precise?

zuckschwerdt commented 8 years ago

Ok, then change erlsom_write:write/3 please. https://github.com/willemdj/erlsom/blob/master/src/erlsom_write.erl#L56 has chardata instead of charlist.