Skip to:

  1. Skip to Jira Navigation
  2. Skip to Side Navigation
  3. Skip to Main Content

clojure.xml parse docstring omits InputSource

Description

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).

user> (use '[clojure.xml :as xml]) nil user> (import '[java.io StringReader]) java.io.StringReader user> (import '[org.xml.sax InputSource]) org.xml.sax.InputSource user> (xml/parse (InputSource. (StringReader. "<egg>green</egg>"))) {:tag :egg, :attrs nil, :content ["green"]}

Approach: Update doc-string to reflect that s also can be an InputSource
Patch: CLJ-1290.patch
Screened by:

Environment

None

Attachments

1
  • 12 Mar 2015, 08:30 PM

Activity

Show:

import September 24, 2014 at 12:06 PM

Comment made by: pbwolf

InputSource is the use of xml/parse that is not encompassed by the docstring:

(xml/parse (InputSource. (StringReader. "<egg>green</egg>")))

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.

Édipo Luis Féderle September 15, 2014 at 9:57 PM

You and mean that de (doc xml/parse) should include also "can be a xml String" ?
I don't know if I understand you right.
Thanks.

Details

Assignee

Reporter

Labels

Approval

Triaged

Patch

Code

Priority

Affects versions

Created November 2, 2013 at 2:00 AM
Updated March 12, 2015 at 8:33 PM

Flag notifications