From abaacb9fd049fe384433d5ca441eb770902c6f2f Mon Sep 17 00:00:00 2001
From: Daniel Himmelstein <daniel.himmelstein@gmail.com>
Date: Fri, 24 Mar 2017 17:13:16 -0400
Subject: [PATCH] Improve read_obo doc

---
 obo/read.py | 10 ++++++++--
 1 file changed, 8 insertions(+), 2 deletions(-)

diff --git a/obo/read.py b/obo/read.py
index e6fbe22..72b6884 100644
--- a/obo/read.py
+++ b/obo/read.py
@@ -10,11 +10,17 @@
 
 def read_obo(path_or_file):
     """
-    Return a networkx MultiDiGraph of the ontology serialized by the
-    specified path.
+    Return a networkx.MultiDiGraph of the ontology serialized by the
+    specified path or file.
 
     This function attempts to follow the specifications provided at:
     http://owlcollab.github.io/oboformat/doc/obo-syntax.html
+
+    Parameters
+    ==========
+    path_or_file : str or file
+        Path, URL, or open file object. If path or URL, compression is
+        inferred from the file extension.
     """
     obo_file = open_read_file(path_or_file)
     typedefs, terms, instances, header = get_sections(obo_file)