Skip to content

Commit 057a8cb

Browse files
committed
[new] Add interface docstrings
1 parent a4cf644 commit 057a8cb

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

src/taoensso/sente/interfaces.cljc

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@
1111
;; Ref. https://github.com/ptaoussanis/sente/issues/102 for more info.
1212

1313
(defprotocol IServerChan ; sch
14-
;; Wraps a web server's own async channel/comms interface to abstract away
15-
;; implementation differences.
14+
"Wraps a web server's own async channel/comms interface to abstract away
15+
implementation differences."
1616
(sch-open? [sch] "Returns true iff the channel is currently open.")
1717
(sch-close! [sch]
1818
"If the channel is open when called: closes the channel and returns true.
@@ -22,8 +22,8 @@
2222
returns true. Otherwise noops and returns falsey."))
2323

2424
(defprotocol IServerChanAdapter ; sch-adapter
25-
;; Wraps a web server's own ring-request->ring-response interface to
26-
;; abstract away implementation differences.
25+
"Wraps a web server's own ring-request->ring-response interface to
26+
abstract away implementation differences."
2727
(ring-req->server-ch-resp [sch-adapter ring-req callbacks-map]
2828
"Given a Ring request (WebSocket handshake or Ajax GET/POST), returns
2929
a Ring response map with a web-server-specific channel :body that

0 commit comments

Comments
 (0)