search

clj-commons / aleph

Asynchronous streaming communication for Clojure - web server, web client, and raw TCP/UDP
http://aleph.io
MIT License
2.54k stars 241 forks source link

chore: formatting docstrings #717

Open anabasalo opened 3 months ago

arnaudgeiser commented 3 months ago

Awesome! Thanks for taking care of this!

KingMob commented 3 months ago

Looks good so far. Thx!

If you want to check how the tables look on cljdoc.org when rendered, I think you can feed it into a Github-Flavored Markdown tool. Check out https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc#docstrings and https://github.com/cljdoc/cljdoc/blob/master/doc/userguide/for-library-authors.adoc#markup-formats for more.

(Setting up a local cljdoc build of the docs is also doable, but involves convoluted Docker-fu.)