JuliaLang/julia

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

Open

#11,161 opened on May 6, 2015

View on GitHub
 (26 comments) (1 reaction) (0 assignees)Julia (48,709 stars) (5,773 forks)batch import
Hacktoberfestdocsgood first issuehelp wanted

Description

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...

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Understanding of Big O notationFamiliarity with Julia's documentation system
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
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.