search

oakes / play-clj

A Clojure game library
The Unlicense
939 stars 73 forks source link

Uninformative documentation #8

Closed poppingtonic closed 10 years ago

poppingtonic commented 10 years ago

Awesome library. However, the docstring "Internal use only," isn't very informative as to what the function actually does, and ignores the (safer) clojure function

(defn- ...)

which actually makes the defined function non-public. I'll submit a patch with my modifications, but please change the docstrings to reflect their actual operation.

oakes commented 10 years ago

Unfortunately I'm not always able to mark them as private, because it would prevent me from using them in macros.

oakes commented 10 years ago

I completely rewrote the doc site and hid all functions that weren't meant to be public, so I hope that helps.