Skip to content
0:00 / 0:00

#clojure#documentation#cider

Towards Awesome Clojure Documentation – Bozhidar Batsov

Metosin

9K subscribers • 19 videos on Hallway

YouTube
  • Recommended by 1 person: 1 in engineering communities.
  • Presented by Bozhidar Batsov
  • An opinion. It argues one side of a question engineers disagree on.

Intermediate. Assumes working knowledge.

3K views9 years ago1 recommendation

Tools and practiceProgramming languagesOpen sourceLisp and ClojureCode review and teamwork

Bozhidar Batsov discusses the state of Clojure documentation, its challenges, and how the community can adopt better practices and conventions.

Most developers allegedly hate writing documentation. On the other hand, pretty much everyone considers good project documentation to be a strong indicator of the project's quality. Go figure! In this session we'll examine the state of the current documentation initiatives and practices in Clojure, some overall problems with documentation in Clojure and some potential solutions. Here's a few topics will touch upon: - the various Clojure documentation projects - the quality of the official Clojure documentation - lessons we can learn from other Lisps when it comes to documentation - adopting a common convention for structuring docstrings - additional documentation metadata Documenting things can be fun and extremely rewarding! Join us and find out how!

Why it's here

1 person recommends this

What people say. Recommended as a discussion on the shortcomings of Clojure's official documentation and how to improve it.

u/202700000000in r/Clojure • Recommends

…English teacher, I hope, otherwise we're screwed. PS: Perhaps the biggest problem is that I can't even imagine how people learnt this language before https://www.braveclojure.com/ was written. The documentation on the main Clojure website I'm sure wasn't written for humans, maybe not by a human either. PSS: /u/moxaj posted this link down below: link to this video It doesn't have as much profanity (surprisingly) but it also says a lot about the state of Clojure's documentation. Honestly it paints an even worse picture than I thought, as soon as anything Clojure-like (is there already something?) but with better documentation comes along, Clojure will basically die. That's my prediction. Unless Cloju…