Liking cljdoc? Tell your friends :D
Clojure only.

clj-zig.diagnostics

Render a structured diagnostic into the human form a Clojure developer reads at the REPL. The data is the contract; this only formats it.

Rendering starts from Clojure: the failing Var and its signature first, then the generated source path, then the compiler's own output:

Could not compile defnz app.core/add

Signature:
  [x :i64
   y :i64
   :ret :i64]

Generated Zig:
  .clj-zig/cache/macos-aarch64/app.core/add-83a1c0/source.zig

Zig error:
  source.zig:2:14: error: expected expression, found ';'
Render a structured diagnostic into the human form a Clojure developer
reads at the REPL. The data is the contract; this only formats it.

Rendering starts from Clojure: the failing Var and its signature first,
then the generated source path, then the compiler's own output:

    Could not compile defnz app.core/add

    Signature:
      [x :i64
       y :i64
       :ret :i64]

    Generated Zig:
      .clj-zig/cache/macos-aarch64/app.core/add-83a1c0/source.zig

    Zig error:
      source.zig:2:14: error: expected expression, found ';'
raw docstring

renderclj

(render {:keys [message var signature] :as diagnostic})

Format a diagnostic map as the multi-line string shown to a developer.

Format a diagnostic map as the multi-line string shown to a developer.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close