Details
-
Type:
Defect
-
Status:
Resolved
-
Priority:
Trivial
-
Resolution: Completed
-
Affects Version/s: Release 1.3
-
Fix Version/s: None
-
Component/s: None
-
Labels:
-
Patch:None
Description
The api-index.html includes wrong links for the following:
- All entries for all listed as part of clojure.test.tap
- All entries for all listed as part of clojure.test.junit
- All entries for all listed as part of clojure.core.protocols
The links point to pages that do not exist. The problem is that the documentation for those entries is on a "parent" page, for example, the link clojure.core.protocols-api.html#clojure.core.protocols/internal-reduce should have been clojure.core-api.html#clojure.core.protocols/internal-reduce
Not a huge bug for me, but you might want to get it fixed.
And please give my huge thanks to whoever is in charge of the documentation, I'm the developer behind Dash, a Mac OS X documentation browser, and I was in the process of creating a documentation set for Clojure, and because you guys have an index, you made my work 1000 times easier.
Gabriel, Thanks for the offer. I fixed this one, but may take you up on it if more come up.
There is currently no wiki page about the autodoc process but it's an excellent suggestion. I'll put it on my list to write something up. In the meantime source on the autodoc program itself is at https://github.com/tomfaulhaber/autodoc and a description of how it works is at http://tomfaulhaber.github.io/autodoc. Two caveats: (1) autodoc is currently undergoing a bunch of work (thus this bug fix) in preparation for a new release and (2) the documentation doesn't talk much about how it's used for documenting Clojure itself.