Skip to content

Commit 272e015

Browse files
committed
Remove remaining @doc macros
1 parent ff82bc9 commit 272e015

File tree

2 files changed

+14
-14
lines changed

2 files changed

+14
-14
lines changed

src/core.jl

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ end
1010

1111
const Symbols = Tuple{Symbol,Vararg{Symbol}}
1212

13-
@doc """
13+
"""
1414
Type-stable axis-specific indexing and identification with a
1515
parametric type.
1616
@@ -47,7 +47,7 @@ A[Axis{:row}(2)] # grabs the second row
4747
A[Axis{2}(2:5)] # grabs the second through 5th columns
4848
```
4949
50-
""" ->
50+
"""
5151
immutable Axis{name,T}
5252
val::T
5353
end
@@ -70,7 +70,7 @@ Base.length(A::Axis) = length(A.val)
7070
Base.convert{name,T}(::Type{Axis{name,T}}, ax::Axis{name,T}) = ax
7171
Base.convert{name,T}(::Type{Axis{name,T}}, ax::Axis{name}) = Axis{name}(convert(T, ax.val))
7272

73-
@doc """
73+
"""
7474
An AxisArray is an AbstractArray that wraps another AbstractArray and
7575
adds axis names and values to each array dimension. AxisArrays can be indexed
7676
by using the named axes as an alternative to positional indexing by
@@ -154,7 +154,7 @@ A[Axis{:time}(ClosedInterval(.2,.4))] # restrict the AxisArray along the time ax
154154
A[ClosedInterval(0.,.3), [:a, :c]] # select an interval and two columns
155155
```
156156
157-
""" ->
157+
"""
158158
immutable AxisArray{T,N,D,Ax} <: AbstractArray{T,N}
159159
data::D # D <:AbstractArray, enforced in constructor to avoid dispatch bugs (https://github.com/JuliaLang/julia/issues/6383)
160160
axes::Ax # Ax<:NTuple{N, Axis}, but with specialized Axis{...} types
@@ -229,13 +229,13 @@ HasAxes{A<:AbstractArray}(::Type{A}) = HasAxes{false}()
229229
HasAxes(A::AbstractArray) = HasAxes(typeof(A))
230230

231231
# Axis definitions
232-
@doc """
232+
"""
233233
axisdim(::AxisArray, ::Axis) -> Int
234234
axisdim(::AxisArray, ::Type{Axis}) -> Int
235235
236236
Given an AxisArray and an Axis, return the integer dimension of
237237
the Axis within the array.
238-
""" ->
238+
"""
239239
axisdim(A::AxisArray, ax::Axis) = axisdim(A, typeof(ax))
240240
@generated function axisdim{T<:Axis}(A::AxisArray, ax::Type{T})
241241
dim = axisdim(A, T)
@@ -460,14 +460,14 @@ function Base.summary(A::AxisArray)
460460
end
461461

462462
# Custom methods specific to AxisArrays
463-
@doc """
463+
"""
464464
axisnames(A::AxisArray) -> (Symbol...)
465465
axisnames(::Type{AxisArray{...}}) -> (Symbol...)
466466
axisnames(ax::Axis...) -> (Symbol...)
467467
axisnames(::Type{Axis{...}}...) -> (Symbol...)
468468
469469
Returns the axis names of an AxisArray or list of Axises as a tuple of Symbols.
470-
""" ->
470+
"""
471471
axisnames{T,N,D,Ax}(::AxisArray{T,N,D,Ax}) = _axisnames(Ax)
472472
axisnames{T,N,D,Ax}(::Type{AxisArray{T,N,D,Ax}}) = _axisnames(Ax)
473473
axisnames{Ax<:Tuple{Vararg{Axis}}}(::Type{Ax}) = _axisnames(Ax)
@@ -481,17 +481,17 @@ axisname{name,T}(::Type{Axis{name,T}}) = name
481481
axisname{name }(::Type{Axis{name }}) = name
482482
axisname(ax::Axis) = axisname(typeof(ax))
483483

484-
@doc """
484+
"""
485485
axisvalues(A::AxisArray) -> (AbstractVector...)
486486
axisvalues(ax::Axis...) -> (AbstractVector...)
487487
488488
Returns the axis values of an AxisArray or list of Axises as a tuple of vectors.
489-
""" ->
489+
"""
490490
axisvalues(A::AxisArray) = axisvalues(A.axes...)
491491
axisvalues() = ()
492492
axisvalues(ax::Axis, axs::Axis...) = tuple(ax.val, axisvalues(axs...)...)
493493

494-
@doc """
494+
"""
495495
axes(A::AxisArray) -> (Axis...)
496496
axes(A::AxisArray, ax::Axis) -> Axis
497497
axes(A::AxisArray, dim::Int) -> Axis
@@ -503,7 +503,7 @@ than `axes(A)[1]`.
503503
504504
For an AbstractArray without `Axis` information, `axes` returns the
505505
default axes, i.e., those that would be produced by `AxisArray(A)`.
506-
""" ->
506+
"""
507507
axes(A::AxisArray) = A.axes
508508
axes(A::AxisArray, dim::Int) = A.axes[dim]
509509
axes(A::AxisArray, ax::Axis) = axes(A, typeof(ax))

src/sortedvector.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
export SortedVector
33

4-
@doc """
4+
"""
55
66
A SortedVector is an AbstractVector where the underlying data is
77
ordered (monotonically increasing).
@@ -48,7 +48,7 @@ A[ClosedInterval(:a,:b), :]
4848
A[ClosedInterval((:a,:x),(:b,:x)), :]
4949
```
5050
51-
""" ->
51+
"""
5252
immutable SortedVector{T} <: AbstractVector{T}
5353
data::AbstractVector{T}
5454
end

0 commit comments

Comments
 (0)