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 (5,773 forks)batch import
Hacktoberfestdocsgood first issuehelp wanted

Repository metrics

Stars
 (48,709 stars)
PR merge metrics
 (Avg merge 20d 6h) (157 merged PRs in 30d)

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

Research direction
Examine how Haskell documents algorithmic complexity and propose a format for Julia's documentation system.
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.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80