Open
Conversation
More details in this Gist: https://gist.github.com/martinklepsch/9f885feb061ec3f03f365e22d0d9bf5b Fixes cljdoc/cljdoc#201
Owner
|
Thanks for telling me about these changes. I'll take a closer look at them later this week, but they all look like useful additions that can be merged back into Codox, so thank you for your work on this! |
|
I'd love to see this included into the codox project 👍 |
roosta
added a commit
to roosta/herb
that referenced
this pull request
Jul 17, 2019
Switch to cljdoc, issues where macros ns and cljs ns would generate duplicate doc entries. See: weavejester/codox#179 cljdoc/cljdoc#155
This was referenced Jul 5, 2023
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Hey @weavejester, I've forked Codox for https://cljdoc.org for a while running on some commits that may also be interesting for mainline Codox. This PR includes a lot of unnecessary commits but I will describe the few relevant ones below and you can cherry pick whatever you like. I can also create a new PR with the ones you're interested in.
Feel free to close this PR after seeing it, it's not really intended to be merged as-is but more of a heads up and an offer to contribute some of the changes below back to Codox.
Trust cljs analyser to read macros correctly
Codox previously did two passes to also read macros for ClojureScript. This is actually no longer necessary with more recent versions of ClojureScript.
cljdoc@3079986
Remove
'quotefrom arglistsFor some reason the
list?check wasn't enough to remove'quoteand I ended up with'quotein arglists.seq?did the trick (and might be more appropriate anyways?).cljdoc@25b01ae
Better handle namespaces defined by multiple files
When there are multiple files (e.g.
.cljand.cljc) for a namespace Codox would analyse those namespaces twice returning the analysis result twice as well. (See cljdoc/cljdoc#155.)cljdoc@3f2ea84
Better support ClojureScript 1.10.439
I noticed some issues (+ more details) with the new CLJS version. Turns out setting
*analyze-deps*tofalsewas never really supported for macro-containing namespaces and we just got lucky.cljdoc@e0cd269
Thanks
Thanks for your excellent work on Codox, it really helped with cljdoc and has been an inspiration in many regards 🙌 If you want I'd be happy to send you some stickers as well, just send me your address via email 🙂