JuliaLang/julia

RFC: adding O() notation in the documentation for functions, like Haskell

Open

#11,161 建立於 2015年5月6日

在 GitHub 查看
 (26 留言) (1 反應) (0 負責人)Julia (48,709 star) (5,773 fork)batch import
Hacktoberfestdocsgood first issuehelp wanted

描述

I noticed that the Haskell string functions actually have O(1) or O(n) as the very first thing in the documentation of many of their functions... What do people think about adding that to the Julia documentation? Julians in general do seem to be rather concerned about performance, that might be useful information...

貢獻者指南

技術棧
無
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
Understanding of Big O notationFamiliarity with Julia's documentation system
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
40
研究方向
This issue proposes adding O() notation to Julia function documentation, similar to Haskell. To start, review the existing documentation style guide (e.g., in the Julia repo's documentation directory) and examples from Haskell's official docs. Then, examine a few Julia function docstrings (e.g., in base/) to see where complexity notes could be inserted. A discussion with maintainers in this issue or a new RFC may be needed to agree on format and scope. Note that the repository language is Julia, which is not in the allowed tech stack, so techStack is empty.