Skip to content

Commit

Permalink
Improve structure of reference
Browse files Browse the repository at this point in the history
  • Loading branch information
Tomas Lycken committed Sep 5, 2016
1 parent 3d4b5a0 commit c4e28da
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
10 changes: 8 additions & 2 deletions docs/src/reference.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Reference

```@autodocs
Modules = [Contour]
```@docs
contour
contours
level
levels
lines
coordinates
Contour.contourlevels
```
14 changes: 7 additions & 7 deletions src/Contour.jl
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,13 @@ function contour(x, y, z, level::Number)
trace_contour(x, y, z,level,get_level_cells(z,level))
end

"""
`contours` returns a set of isolines.
You'll usually call [`levels`](@ref) on the output of `contours`.
"""
contours(::Any...)

"""
`contours(x,y,z,levels)` Trace the contour levels indicated by the `levels`
argument.
Expand All @@ -84,13 +91,6 @@ end
"""
contours(x,y,z) = contours(x,y,z,10)

"""
`contours` returns a set of isolines.
You'll usually call [`levels`](@ref) on the output of `contours`.
"""
contours

"""
`contourlevels(z,n)` Examines the values of `z` and chooses `n` evenly spaced
levels to trace.
Expand Down

0 comments on commit c4e28da

Please sign in to comment.