document *options*

[daslu]

No description provided.

[behrica]

@daslu
This is indeed important.

(-> plotly-example
    (kind/plotly {:style
                  {:width "300px"
                   :height "300px"}}))

A "kind" implementer need to know all allowed options for all kinds....

[behrica]

Maybe create a malli spec "per kind" in "kindly-render", at least for "manual inspection".

[daslu]

Good idea

[behrica]

To give you an idea:
Clojupyter currently supports this:

(defn malli-schema-for [kind]
  (m/schema
   (case kind
     :kind/fn  [:map {:closed true}  [:kindly/f {:optional true} fn?]]
     :kind/reagent  [:map {:closed true}  [:html/deps {:optional true} [:sequential keyword?]]]
     [:map {:closed true}])))

I can even generate documentation from it:

(require '[malli.experimental.describe :as med])
(med/describe [:map {:closed true}  [:html/deps {:optional true} [:sequential keyword?]]])
;;=> "map where {:html/deps (optional) -> <sequence of keyword>} with no other keys"

[behrica]

Or error message for users:

(kind/html "" {:invalid-option 1})
->
 [:div
  {:style "color:red"}
  "invalid options '{:invalid-option 1}' for kind :kind/html : {:invalid-option [\"disallowed key\"]}"]

[behrica]

as well discussed here:
https://clojurians.zulipchat.com/#narrow/channel/454856-kindly-dev/topic/document.20kind.20options