JuliaLang/julia

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

Open

#11,161 opened on 2015年5月6日

GitHub で見る
 (26 comments) (1 reaction) (0 assignees)Julia (48,709 stars) (5,773 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
half day
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.