Merge pull request #17616 from JuliaLang/teh/oneto_docstring

Add docstring for Base.OneTo [ci skip]
JuliaLang · Jul 26, 2016 · 9fbe3b5 · 9fbe3b5
2 parents 9c0c763 + fe45425
commit 9fbe3b5
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/base/range.jl b/base/range.jl
@@ -76,6 +76,13 @@ unitrange_last{T}(start::T, stop::T) =
     ifelse(stop >= start, convert(T,start+floor(stop-start)),
                           convert(T,start-one(stop-start)))
 
+"""
+    Base.OneTo(n)
+
+Define an `AbstractUnitRange` that behaves like `1:n`, with the added
+distinction that the lower limit is guaranteed (by the type system) to
+be 1.
+"""
 immutable OneTo{T<:Integer} <: AbstractUnitRange{T}
     stop::T
     OneTo(stop) = new(max(zero(T), stop))

diff --git a/doc/stdlib/math.rst b/doc/stdlib/math.rst
@@ -311,6 +311,12 @@ Mathematical Operators
 
    Construct a range by length, given a starting value and optional step (defaults to 1).
 
+.. function:: Base.OneTo(n)
+
+   .. Docstring generated from Julia source
+
+   Define an ``AbstractUnitRange`` that behaves like ``1:n``\ , with the added distinction that the lower limit is guaranteed (by the type system) to be 1.
+
 .. _==:
 .. function:: ==(x, y)