Permalink
Browse files

DOC update docstrings

  • Loading branch information...
1 parent c3b3cc8 commit 5c1881033018588307721d57aaadb48ecbea6c9e @kwgoodman committed Jan 7, 2014
Showing with 11 additions and 11 deletions.
  1. +11 −11 la/io.py
View
22 la/io.py
@@ -99,11 +99,11 @@ def __init__(self, filename):
>>> y = io['x'] # <-- Load
>>> type(y)
- <class 'la.io.io.lara'>
+ la.io.io.lara
>>> type(y[:])
- <class 'la.deflarry.larry'>
+ la.deflarry.larry
>>> type(y[2:])
- <class 'la.deflarry.larry'>
+ la.deflarry.larry
Test if x is in the archive:
@@ -288,8 +288,10 @@ def __init__(self, filename, key):
Parameters
----------
- group : h5py.Group
- An instance of the h5py Group object that contains a larry.
+ filename : str
+ The `filename` is the path to the archive.
+ key : str
+ Name of larry in archive.
Example
-------
@@ -306,18 +308,16 @@ def __init__(self, filename, key):
Actually, only the labels are loaded. y is a lara object:
>>> type(y)
- <class 'la.io.io.lara'>
- >>> type(y.x)
- <class 'h5py.highlevel.Dataset'>
+ la.io.lara
>>> type(y.label)
- <type 'list'>
+ list
To convert y into a larry just index into y:
>>> type(y[:])
- <class 'la.deflarry.larry'>
+ la.deflarry.larry
>>> type(y[2:])
- <class 'la.deflarry.larry'>
+ la.deflarry.larry
"""

0 comments on commit 5c18810

Please sign in to comment.