Skip to content

Commit

Permalink
improve doc strings
Browse files Browse the repository at this point in the history
  • Loading branch information
dfsp-spirit committed Feb 12, 2021
1 parent 4fcef96 commit cd65978
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 4 deletions.
4 changes: 1 addition & 3 deletions src/FreeSurfer.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ using Printf

export read_curv, write_curv, Curv, CurvHeader
export read_surf, num_vertices, num_faces, export_to_obj, BrainMesh, FsSurface, FsSurfaceHeader
export read_label
export read_annot, FsAnnot, ColorTable, regions, vertex_regions, region_vertices, label_from_rgb
export read_mgh, Mgh, MghHeader, mgh_vox2ras
export read_label, read_annot, FsAnnot, ColorTable, regions, vertex_regions, region_vertices, label_from_rgb, read_mgh, Mgh, MghHeader, mgh_vox2ras

include("./utils.jl")
include("./fs_common.jl")
Expand Down
13 changes: 12 additions & 1 deletion src/utils.jl
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,18 @@ function _read_fixed_length_string(io::IO, num_chars::Integer; strip_trailing::A
end


""" Get the path of the NeuroFormats test data directory. """
"""
tdd()
Get the path of the NeuroFormats test data directory.
This is useful if you do not have own neuroimaging data at hand but still want to try NeuroFormats: you can use the unit test data that comes with the package. Explore the returned directory to see what is available.
# Examples
```julia-repl
julia> curv_file = joinpath(tdd(), "subjects_dir/subject1/surf/lh.thickness");
```
"""
function tdd()
joinpath(@__DIR__, "..", "test", "data")
end
Expand Down

0 comments on commit cd65978

Please sign in to comment.