Skip to content

Commit a10913c

Browse files
authored
Merge pull request #171 from fschuetz04/patch-1
Correct arguments for mdfreader.Mdf in readme
2 parents 590c68d + 7f4d1a0 commit a10913c

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -87,11 +87,11 @@ Command example in ipython:
8787
# you can print file content in ipython with a simple:
8888
yop
8989
# alternatively, for max speed and smaller memory footprint, read only few channels
90-
yop=mdfreader.Mdf('NameOfFile', channelList=['channel1', 'channel2'], convertAfterRead=False)
90+
yop=mdfreader.Mdf('NameOfFile', channel_list=['channel1', 'channel2'], convert_after_read=False)
9191
# also possible to keep data compressed for small memory footprint, using Blosc module
9292
yop=mdfreader.Mdf('NameOfFile', compression=True)
9393
# for interactive file exploration, possible to read the file but not its data to save memory
94-
yop=mdfreader.Mdf('NameOfFile', noDataLoading=True) # channel data will be loaded from file if needed
94+
yop=mdfreader.Mdf('NameOfFile', no_data_loading=True) # channel data will be loaded from file if needed
9595
# parsing xml metadata from mdf4.x for many channels can take more than just reading data.
9696
# You can reduce to minimum metadata reading with below argument (no source information, attachment, etc.)
9797
yop=mdfreader.Mdf('NameOfFile', metadata=0) # 0: full, 2: minimal
@@ -142,4 +142,4 @@ Command example in ipython:
142142
yop.write('NewNameOfFile') # write in same version as original file after modifications
143143
yop.write4('NameOfFile', compression=True) # write mdf version 4.1 file, data compressed
144144
yop.write3() # write mdf version 3 file
145-
```
145+
```

0 commit comments

Comments
 (0)