[#CLJ-412] clojure.xml/emit, emit-element are not documented at clojure.org - Clojure JIRA

Details

Type: Enhancement
Status: Closed
Resolution: Declined
Affects Version/s: None
Fix Version/s: Backlog
Component/s: None
Labels:
None

Description

Neither function makes an appearance here:
http://clojure.github.com/clojure/clojure.xml-api.html
Despite the fact that neither appears to be private. Perhaps the doc generator just ignores all functions that have no doc comment?

Activity

Ascending order - Click to sort in descending order

Hide

Permalink

Assembla Importer added a comment - 24/Aug/10 12:34 AM

Converted from http://www.assembla.com/spaces/clojure/tickets/412

Show

Assembla Importer added a comment - 24/Aug/10 12:34 AM Converted from http://www.assembla.com/spaces/clojure/tickets/412

Hide

Permalink

Assembla Importer added a comment - 24/Aug/10 12:34 AM

stu said: If a var is (a) public (b) has a docstring and (c) has :added metadata, then the Clojure team is committed to supporting it. These vars don't meet the criteria. In the context of a broader overhaul of XML support these might become official APIs.

Show

Assembla Importer added a comment - 24/Aug/10 12:34 AM stu said: If a var is (a) public (b) has a docstring and (c) has :added metadata, then the Clojure team is committed to supporting it. These vars don't meet the criteria. In the context of a broader overhaul of XML support these might become official APIs.

Hide

Permalink

Assembla Importer added a comment - 24/Aug/10 12:34 AM

bpsm said: That makes sense. I wasn't aware of those conventions. Perhaps the library should advertise itself as being only for XML reading:

--- a/src/clj/clojure/xml.clj
+++ b/src/clj/clojure/xml.clj
@@ -6,7 +6,7 @@
 ;   the terms of this license.
 ;   You must not remove this notice, or any other, from this software.
 
-(ns ^{:doc "XML reading/writing."
+(ns ^{:doc "XML reading."
        :author "Rich Hickey"}
   clojure.xml
   (:import (org.xml.sax ContentHandler Attributes SAXException)

Show

Assembla Importer added a comment - 24/Aug/10 12:34 AM bpsm said: That makes sense. I wasn't aware of those conventions. Perhaps the library should advertise itself as being only for XML reading:

--- a/src/clj/clojure/xml.clj
+++ b/src/clj/clojure/xml.clj
@@ -6,7 +6,7 @@
 ;   the terms of this license.
 ;   You must not remove this notice, or any other, from this software.
 
-(ns ^{:doc "XML reading/writing."
+(ns ^{:doc "XML reading."
        :author "Rich Hickey"}
   clojure.xml
   (:import (org.xml.sax ContentHandler Attributes SAXException)

People

Assignee:

Unassigned

Reporter:

Anonymous

Vote (0)

Watch (0)

Dates

Created:

23/Jul/10 12:57 AM

Updated:

24/Aug/10 12:34 AM

Resolved:

24/Aug/10 12:34 AM