Skip to content
This repository has been 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
2 changes: 1 addition & 1 deletion peregrine/samples.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down