Skip to content
This repository was archived by the owner on Apr 13, 2021. It is now read-only.

updates documentation to tell type of argument #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
updates documentation to tell type of argument
It looks like the `{'int8'}` was still there from before bf5621c in which the default format was changed to `piksi`.
StefanD986 committed Feb 11, 2016
commit 0e11e42ce59bb4ca595d08ab7b90f72eb5342164
2 changes: 1 addition & 1 deletion peregrine/samples.py
Original file line number Diff line number Diff line change
@@ -25,7 +25,7 @@ def load_samples(filename, num_samples=-1, num_skip=0, file_format='piksi'):
Number of samples to read, ``-1`` means the whole file.
num_skip : int, optional
Number of samples to discard from the beginning of the file.
file_format : {'int8'}, optional
file_format : string, optional
Format of the sample data file. Takes one of the following values:
* `'int8'` : Binary file consisting of a packed array of 8-bit signed
integers.