weavejester / hiccup

Fast library for rendering HTML in Clojure
http://weavejester.github.io/hiccup
Eclipse Public License 1.0
2.68k stars 174 forks source link

Documentation on seq-inclusion could be more clear #83

Closed ghost closed 11 years ago

ghost commented 11 years ago

Though it can be deduced from the Syntax docs, it's not immediately clear that whatever collection one wishes to include in an element's vector must not be a vector on itself, which is easy to overlook at first, vectors being the most commonly used sequence in Clojure and all.

weavejester commented 11 years ago

Vectors might be sequences in the abstract sense, but they are not Clojure seqs:

user=> (seq? [])
false

I guess I could put a note in there to that effect, but I'm a little leery about including documentation about Clojure itself. It's the start of a potentially slippery slope.

That said, a single sentence of clarification might not hurt, as its not unusual for those new to Clojure to assume that collections and seqs are the same thing.

weavejester commented 11 years ago

Updated wiki with a reminder that vectors and sets are not seqs.