Welcome to the Flexblock Documentation! This is the best place to learn about how Flexblock works! If you are looking for something specific, see the table of contents. Otherwise, read on!
Flexblock has two different types of documentation. There are comments and docstrings in the source code, which describe specifically how small parts of the code (usually functions) work. For documentation about the broader system, and how different pieces of the system work together, read these docs.
If you are looking for specific details about the implementation of a certain function, you probably won't find it here. You should look in the source code. Below is an example function, showing how documentation might be formatted in code. For more information on clojure, see Learn Clojure
(defn add-two-numbers
"This is a Docstring. Docstings come before the
argument vecor of a function, and gives an overview of how it
works. This particular function adds `x` and `y`."
[x y]
;; This is a comment. Comments start with one or more semicolons.
;; Comments usually describe a specific detail of what happens on
;; the line below the comment.
;; Here is where we do the adding.
(+ x y))