Skip to content

Commit 0e80d48

Browse files
committed
Document client_from_file
1 parent 2e87a40 commit 0e80d48

1 file changed

Lines changed: 7 additions & 1 deletion

File tree

ox3apiclient/__init__.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -213,7 +213,13 @@ def delete(self, url):
213213

214214

215215
def client_from_file(file_path='.ox3rc', env=None):
216-
""""""
216+
"""Return an instance of ox3apiclient.Client with data from file_path.
217+
218+
Keyword arguments:
219+
file_path -- the file to load. Default is '.ox3rc' form current dir.
220+
env -- the env section to load. Default will be first env section.
221+
222+
"""
217223
cp = ConfigParser.RawConfigParser()
218224
cp.read(file_path)
219225

0 commit comments

Comments
 (0)