This page is not created by, affiliated with, or supported by Slack Technologies, Inc.
2018-01-11
Channels
- # aws (2)
- # beginners (38)
- # boot (21)
- # boot-dev (8)
- # cider (51)
- # cljsrn (3)
- # clojars (23)
- # clojure (99)
- # clojure-austin (7)
- # clojure-brasil (1)
- # clojure-dev (8)
- # clojure-dusseldorf (1)
- # clojure-estonia (20)
- # clojure-greece (4)
- # clojure-italy (3)
- # clojure-russia (1)
- # clojure-spec (28)
- # clojure-uk (47)
- # clojurescript (47)
- # core-logic (3)
- # cursive (9)
- # data-science (1)
- # datomic (50)
- # docs (12)
- # emacs (5)
- # fulcro (60)
- # graphql (33)
- # hoplon (8)
- # jobs-discuss (1)
- # keechma (31)
- # lein-figwheel (10)
- # leiningen (4)
- # off-topic (70)
- # om (1)
- # onyx (15)
- # pedestal (5)
- # re-frame (185)
- # reagent (14)
- # remote-jobs (8)
- # ring-swagger (7)
- # rum (17)
- # shadow-cljs (193)
- # specter (6)
- # sql (51)
- # unrepl (8)
can someone think of a project that makes exemplary use of codox (i.e. usage of doc/
) and also tags releases on github?
@tsulej I’m working on a tool that may utilise tags — unfortunately tagging releases doesn’t seem to be a very common thing 😕
(which I believe is unfortunate on it’s own, not just because I need it 🙂)
I don't tag releases too... still working on snapshots. However I started to enhance my documentation with examples in metatags. Examples can be run during doc generation. I can also generate images from examples. Since in codox I can't run my code snippets all process looks like: metadata -> alter :doc tag from info (examples) in tags -> image generation -> codox
(defn point
"Draw point at `x`,`y` or `^Vec2` position.
It's implemented as very short line. Consider using `(rect x y 1 1)` for speed when `x` and `y` are integers."
{:examples [(ex/example-gen-image "Sequence of points."
(doseq [x (range 10 159 10)] (point canvas x x)))
(ex/example-gen-image "Magnified point can look differently when different stroke settings are used."
(-> canvas
(scale 80.0)
(set-stroke 0.5)
(point 0.5 0.5)
(set-stroke 0.5 BasicStroke/CAP_SQUARE BasicStroke/JOIN_MITER)
(point 1.5 1.5)))]}
([canvas ^double x ^double y]
(line canvas x y (+ x 10.0e-6) (+ y 10.0e-6))
canvas)
([canvas ^Vec2 vec]
(point canvas (.x vec) (.y vec))))
quick and dirty code https://github.com/Clojure2D/clojure2d/blob/master/src/meta_doc/core.clj
@tsulej that’s interesting to see, thanks for sharing!