2024 Clojure 状态调查中分享您的想法!

欢迎!请查看关于页面以了解更多关于这个工作方式的信息。

0
core.contracts

关于文档的可用性和互联方式存在一些问题

  • 目前,大多数人可能访问 https://github.com/clojure/core.contracts 并阅读README - 但它没有指向 {{./docs/}} => 在那里添加链接
  • 并不清楚如何浏览文档;我猜 .org
    文件应该导出为 * } 但并非所有这些都被导出。我还
    假设导出的 markdown 文件应该在 https://github.com/clojure/core.contracts/wiki 下可用,即推送到 [email protected]:clojure/core.contracts.wiki.git
  • 一些问题
     *  the link "return to documentation" on e.g. "with-constraints" should point to /clojure/core.contracts/wiki, not /clojure/core.contracts/docs.html
    
    • 如果 wiki 已真正导出,主页应说明它是不变的
    • 主页上的链接 有一个多余的 'wiki' (在 wiki 中手动修复 - 下次导出将被覆盖)
    • 一些链接已损坏,例如 (链接:defconstrainedfn)(/clojure/core.contracts/wiki/defconstrainedfn) 在 f.ex. {{contract}}; (链接:with-constraints)(/clojure/core.contracts/with-constraints/) (缺少 /wiki/),(链接:defcontract)(/clojure/core.contracts/wiki/defcontract/)

如果文档更容易访问和浏览,这当然会帮助项目 :-)

感谢

1 答案

0
参考:https://clojure.atlassian.net/browse/CCONTRACTS-5 (由 alex+import 报告)
...