From cd659780715fcaec1dda08e30e9caa5253f0e0cf Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Tim=20Sch=C3=A4fer?= <ts+code@rcmd.org>
Date: Fri, 12 Feb 2021 13:27:48 +0100
Subject: [PATCH] improve doc strings

---
 src/FreeSurfer.jl |  4 +---
 src/utils.jl      | 13 ++++++++++++-
 2 files changed, 13 insertions(+), 4 deletions(-)

diff --git a/src/FreeSurfer.jl b/src/FreeSurfer.jl
index 257d458..de2d256 100644
--- a/src/FreeSurfer.jl
+++ b/src/FreeSurfer.jl
@@ -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")
diff --git a/src/utils.jl b/src/utils.jl
index eedcf47..b76aad3 100644
--- a/src/utils.jl
+++ b/src/utils.jl
@@ -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