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.