[CLJ-1290] clojure.xml parse docstring omits InputSource Created: 01/Nov/13 Updated: 12/Mar/15
|Affects Version/s:||Release 1.6|
|Labels:||docstring, newbie, xml|
The clojure.xml parse docstring mentions that parameter s "can be a File, InputStream or String naming a URI." But those choices do not cover a common case, parsing the value of a String. Actually, parse also allows InputSource, which solves the problem. The docstring should mention InputSource (or clarify its omission, if not inadvertent).
Approach: Update doc-string to reflect that s also can be an InputSource
|Comment by Édipo L Féderle [ 15/Sep/14 3:57 PM ]|
You and mean that de (doc xml/parse) should include also "can be a xml String" ?
|Comment by Phill Wolf [ 24/Sep/14 6:06 AM ]|
InputSource is the use of xml/parse that is not encompassed by the docstring:
Perhaps xml/parse aimed to hide InputSource by making specific provision for some of InputSource's capabilities. But reading a String is important, and xml/parse does not accept a StringReader, so InputSource remains important.