From 9dbc9d15dc36453bea393a7e241bc6f420ff5ef0 Mon Sep 17 00:00:00 2001
From: Robert Smallshire <robert@smallshire.org.uk>
Date: Thu, 7 May 2015 13:51:01 +0200
Subject: [PATCH] Improves API documentation for reader.py.

---
 segpy/reader.py | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

diff --git a/segpy/reader.py b/segpy/reader.py
index 074e9f4..6e3f761 100644
--- a/segpy/reader.py
+++ b/segpy/reader.py
@@ -39,7 +39,8 @@ def create_reader(fh, encoding=None, trace_header_format=TraceHeaderRev1, endian
             None (the default) a heuristic will be used to guess the
             header encoding.
 
-        trace_header_format: The class defining the layout of the trace header.
+        trace_header_format: An optional class defining the layout of the
+            trace header. Defaults to TraceHeaderRev1.
 
         endian: '>' for big-endian data (the standard and default), '<'
                 for little-endian (non-standard)
@@ -150,7 +151,7 @@ class SegYReader(object):
             textual_reel_header: A sequence of forty 80-character Unicode strings
                 containing header data.
 
-            binary_reel_header: A dictionary containing reel header data.
+            binary_reel_header: A Header object containing reel header data.
 
             extended_textual_headers: A sequence of sequences of Unicode strings.