Fork me on GitHub
#rewrite-clj2019-04-20
>
sogaiu01:04:56

thanks for that @borkdude

sogaiu23:04:17

btw, i noticed the use of ^:no-doc in some locations (e.g. custom_zipper/core.clj*). i had assumed that meant there was no documentation, but there are some instances where there is also a docstring. i haven't had much luck turning up what that means. does anyone here know or have better ideas about it?

lread23:04:05

yeah, I do

lread23:04:23

at least I think I do

lread23:04:01

^:no-doc indicates to codox, and now more importantly to us cljdoc, that the item should not be included in documentation it generates. I believe that the original author of rewrite-clj only wanted to generate docs for what he considered the public api.

lread23:04:58

if you have a peek at rewrite-clj’s current codox generated docs, I think you’ll get the idea: http://xsc.github.io/rewrite-clj/rewrite-clj.node.html. My intent is to match rewrite-clj here, but I will be using cljdoc.

lread23:04:49

does that make sense @sogaiu ?

sogaiu23:04:26

ah, yes, thanks a lot for the explanation :)

lread23:04:05

Thanks for asking! I’ll add a todo to make it clear what is publicly documented and why.