Clojurians Log v2
rewrite-clj
Medium request: can the docs list the node types and give examples of given input to create one? There’s the Reader Macro Chars list but that's about how sexpr renders it. For an example of the potential confusion, I would naively expect that true/false/nil aren't “token” types, but they are.
I can open a GitHub issue for this if desired, and if pointed to the relevant information in the source code, would be willing to write some initial docs as well.
Hiya @nbtheduke! Do you mean the type returned by the node’s tag?
Maybe I should get around to this too: https://github.com/clj-commons/rewrite-clj/issues/114
Yes, the keyword returned by the function rewrite-clj.node. A list of possible tags (and some description and inputs) would be very helpful. My apologies for using the wrong words
Yeah I agree, that is part of the public interface but maybe not documented very well and maybe only incidentally mentioned. So I’m thinking the user guide and docstrings need a little updating. Is this what you were thinking too?
Yes, that’s about right. Like I said, I’m willing to help write them if that's desired.
How about I take a crack at it sometime soon and you can help me to review for clarity?
Raised an issue: https://github.com/clj-commons/rewrite-clj/issues/177 Thanks for bringing these things up @nbtheduke, it is very helpful!
Small request: include link to the generated api docs on the github page for ease of access
We have a cljdoc badge. Do you want something also in the little GitHub about blurb?
I did not know the badge was a link! That’s helpful info lol. I think more clarity is better overall, so including the link in the “external website link” in GitHub would be ideal to me.
Done!
Thank you so much
My pleasure