- fixed docstring for :kind/image (fixing #16)

scicloj · Aug 8, 2024 · e4861fe · e4861fe
1 parent 6c0adeb
commit e4861fe
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,9 @@
 # Change Log
 All notable changes to this project will be documented in this file. This change log follows the conventions of [keepachangelog.com](http://keepachangelog.com/).
 
+## [4-beta6]
+- fixed docstring for `:kind/image` (fixing #16)
+
 ## [4-beta5] - 2024-06-14
 - added `:kind/tex`
 

diff --git a/resources/kinds.edn b/resources/kinds.edn
@@ -158,7 +158,7 @@
 
  ["specific types"
   [[image {:display-as "an image"
-           :example    "https://raw.githubusercontent.com/scicloj/graphic-design/live/icons/Kindly.svg"}]
+           :example    "At the moment, java BufferedImage objects are supported."}]
    [dataset {:display-as "a table"
              :example    (->> (System/getProperties)
                               (map (fn [[k v]] {:k k :v (apply str (take 40 (str v)))}))

diff --git a/src/scicloj/kindly/v4/kind.cljc b/src/scicloj/kindly/v4/kind.cljc
@@ -160,7 +160,7 @@ json-schema: "
 
 (defn image
   "display-as: an image
-example: https://raw.githubusercontent.com/scicloj/graphic-design/live/icons/Kindly.svg"
+example: At the moment, java BufferedImage objects are supported."
   ([] :kind/image)
   ([value] (attach-kind-to-value value :kind/image)) 
   ([value options] (scicloj.kindly.v4.kind/image (vary-meta value assoc :kindly/options options))))