How do I document multimethods?

Community Center Beginners
1

Hello All, I have a doubt. How can I document multimethods? For example, something like this, https://codeberg.org/mindaslab/rswan/src/branch/v1/src/rswan/multi_swan.clj

I did check out https://stackoverflow.com/questions/58119835/how-to-document-a-defmethod-function, but I am unable to understand it.

Thank you.

2

There are existing discussions on Slack, try searching for in:#clojure docstring defmulti.

tl;dr: you can document the var created with defmulti and that’s about it. If the docstring is for users, they should only care about defmulti. If the docstring is for other developers, just leave a comment near each defmethod.

2 Likes