rewrite-clj

https://github.com/clj-commons/rewrite-clj
2019-04-20T01:30:56.068100Z

thanks for that @borkdude

2019-04-20T23:12:17.069900Z

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?

lread 2019-04-20T23:13:05.070300Z

yeah, I do

lread 2019-04-20T23:13:23.070700Z

at least I think I do

lread 2019-04-20T23:18:01.075100Z

^: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.

lread 2019-04-20T23:22:58.078100Z

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.

lread 2019-04-20T23:34:49.078800Z

does that make sense @sogaiu ?

2019-04-20T23:36:26.079700Z

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

lread 2019-04-20T23:39:05.081200Z

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