Skip to content

Commit a03dd8d

Browse files
authored
cljdoc tweaks (#288)
1 parent edd154a commit a03dd8d

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
[![CircleCI](https://circleci.com/gh/borkdude/speculative/tree/master.svg?style=svg)](https://circleci.com/gh/borkdude/speculative/tree/master)
44
[![Clojars Project](https://img.shields.io/clojars/v/speculative.svg)](https://clojars.org/speculative)
5+
[![cljdoc badge](https://cljdoc.org/badge/speculative/speculative)](https://cljdoc.org/d/speculative/speculative/CURRENT)
56

67
speculative is a collection of specs for the functions in `clojure.core`. While
78
its ultimate goal is to be rendered obsolete by these or similar specs being

doc/users.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@
22

33
- [Rollcage](https://github.com/circleci/rollcage), a Clojure client for Rollbar
44
- [Planck](https://github.com/planck-repl/planck), a stand-alone ClojureScript REPL
5+
- [Re-find](https://re-find.it), an app to find Clojure functions using specs.

src/speculative/instrument.cljc

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
(ns speculative.instrument
2-
"Loads all relevant speculative specs. Provides functions to only
3-
instrument and unstruments specs provided by speculative. Alpha,
4-
subject to change."
2+
"Loads all relevant speculative specs. Undefines specs that are not
3+
suited or useful to instrument and therefore makes it safe to
4+
call `(stest/instrument)`. Provides functions to only instrument and
5+
unstruments specs provided by speculative."
56
(:require
67
[clojure.set :as set]
78
[clojure.string :as str]
@@ -36,7 +37,7 @@
3637

3738
(impl/deftime
3839
(defmacro unload-blacklist
39-
"Make it safe to call (stest/instrument) by unloading blacklisted
40+
"Make it safe to call `(stest/instrument)` by unloading blacklisted
4041
specs. Respects environment variable
4142
`SPECULATIVE_NO_UNLOAD_BLACKLIST` or `goog-define`
4243
`no-unload-blacklist?`, unless `force?` is true. To undo unloading

src/speculative/specs.cljc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
[clojure.spec.gen.alpha :as gen]
77
#?(:cljs [goog.string])))
88

9-
#?(:cljs (def ^:private ^:no-doc
9+
#?(:cljs (def ^:private
1010
before-1_10_439?
1111
(and *clojurescript-version*
1212
(pos? (goog.string/compareVersions "1.10.439"

0 commit comments

Comments
 (0)