Improve read_obo doc

dhimmel · Mar 24, 2017 · abaacb9 · abaacb9
1 parent b239acd
commit abaacb9
Showing 1 changed file with 8 additions and 2 deletions.
diff --git 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)