Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: show specs in HTML-documentation #165

Open
n2o opened this issue Sep 13, 2017 · 1 comment
Open

Feature: show specs in HTML-documentation #165

n2o opened this issue Sep 13, 2017 · 1 comment

Comments

@n2o
Copy link

n2o commented Sep 13, 2017

Specs appear in the documentation when called in a REPL. It would be great when these specs would appear in the generated HTML files.

Minimal example:

(require '[clojure.spec.alpha :as s]
         '[clojure.repl :refer [doc]])

(s/fdef add
        :args (s/cat :x int? :y int?)
        :ret int?)

(defn add
  "Insecure add."
  [x y] (+ x y))

(doc add)

Prints:

foo.core/add
([x y])
  Insecure add.
Spec
  args: (cat :x int? :y int?)
  ret: int?
@tirkarthi
Copy link

Seems this was merged and reverted due to some issues with reader in #134 . Will be great to see this since the core docs display specs with autodoc : https://github.com/tomfaulhaber/autodoc

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants