Clojure

clojure.core/definterface is not included in the API docs

Details

  • Type: Defect Defect
  • Status: Closed Closed
  • Priority: Minor Minor
  • Resolution: Completed
  • Affects Version/s: Release 1.3
  • Fix Version/s: Release 1.5
  • Component/s: None
  • Labels:
  • Patch:
    Code
  • Approval:
    Ok

Description

Is definterface meant to be a public API? If yes, then it needs a docstring.

Activity

Tassilo Horn made changes -
Field Original Value New Value
Attachment 0010-Add-docstring-to-definterface.patch [ 10789 ]
Tassilo Horn made changes -
Attachment 0006-Add-docstring-to-definterface.patch [ 10786 ]
Tassilo Horn made changes -
Attachment 0001-Add-docstring-and-added-metadata-to-definterface.patch [ 10984 ]
Tassilo Horn made changes -
Attachment 0010-Add-docstring-to-definterface.patch [ 10789 ]
Stuart Sierra made changes -
Waiting On richhickey
Approval Screened [ 10004 ]
Description The Clojure API docs at http://clojure.github.com/clojure/index.html don't list {{definterface}} at all, although this macro is more convenient to use than {{gen-interface}}, which appears in the API docs. This applies to the API docs of all versions from 1.1 to 1.4.

Probably, that's because {{definterface}} doesn't have a docstring. The attached patch adds one.

As a side-note: Why doesn't {{definterface}} allow for specifying super-interfaces as {{gen-interface}} does using its :extends clause?
Is {{definterface}} meant to be a public API? If yes, then it needs a docstring.
Priority Major [ 3 ] Minor [ 4 ]
Rich Hickey made changes -
Fix Version/s Approved Backlog [ 10034 ]
Tassilo Horn made changes -
Attachment 0001-Add-docstring-and-added-metadata-to-definterface.patch [ 10984 ]
Tassilo Horn made changes -
Attachment 0001-Add-docstring-and-added-metadata-to-definterface.patch [ 11275 ]
Stuart Halloway made changes -
Attachment CLJ-917-definterface.patch [ 11578 ]
Stuart Halloway made changes -
Waiting On richhickey
Fix Version/s Approved Backlog [ 10034 ]
Fix Version/s Release 1.5 [ 10150 ]
Rich Hickey made changes -
Approval Screened [ 10004 ] Ok [ 10007 ]
Tassilo Horn made changes -
Tassilo Horn made changes -
Attachment 0001-Add-docstring-and-added-metadata-to-definterface.patch [ 11275 ]
Stuart Halloway made changes -
Resolution Completed [ 1 ]
Status Open [ 1 ] Closed [ 6 ]

People

Vote (0)
Watch (2)

Dates

  • Created:
    Updated:
    Resolved: