add python code sample to module docstrings

freesurfer_volume_reader/__init__.py

@@ -2,6 +2,12 @@
 Read hippocampal subfield volumes computed by Freesurfer
 
 https://surfer.nmr.mgh.harvard.edu/fswiki/HippocampalSubfields
+
+>>> from freesurfer_volume_reader.freesurfer import HippocampalSubfieldsVolumeFile
+>>>
+>>> for volume_file in HippocampalSubfieldsVolumeFile.find('/my/freesurfer/subjects'):
+>>>     print(volume_file.read_volumes_mm3())
+>>>     print(volume_file.read_volumes_dataframe())
 """
 
 import argparse
@@ -19,7 +25,8 @@ def remove_group_names_from_regex(regex_pattern: str) -> str:
 
 
 def main():
-    argparser = argparse.ArgumentParser(description=__doc__)
+    argparser = argparse.ArgumentParser(description=__doc__,
+                                        formatter_class=argparse.RawDescriptionHelpFormatter)
     argparser.add_argument('--filename-regex', type=re.compile,
                            default=remove_group_names_from_regex(
                                HippocampalSubfieldsVolumeFile.FILENAME_PATTERN),

freesurfer_volume_reader/freesurfer.py

@@ -1,3 +1,15 @@
+"""
+Read hippocampal subfield volumes computed by Freesurfer
+
+https://surfer.nmr.mgh.harvard.edu/fswiki/HippocampalSubfields
+
+>>> from freesurfer_volume_reader.freesurfer import HippocampalSubfieldsVolumeFile
+>>>
+>>> for volume_file in HippocampalSubfieldsVolumeFile.find('/my/freesurfer/subjects'):
+>>>     print(volume_file.read_volumes_mm3())
+>>>     print(volume_file.read_volumes_dataframe())
+"""
+
 import os
 import re
 import typing