search

jjhelmus / nmrglue

A module for working with NMR data in Python
BSD 3-Clause "New" or "Revised" License
211 stars 86 forks source link

nmrglue.fileio.bruker.read has parameter read_prog but doc states read_pprog #22

Closed mfitzp closed 9 years ago

mfitzp commented 9 years ago

The Bruker read function accepts a parameter read_prog that determines whether the pulseprogram file is loaded:

def read(dir=".", bin_file=None, acqus_files=None, pprog_file=None,
         shape=None, cplex=None, big=None, read_prog=True, read_acqus=True):

..however according to the docs (and for consistency) this should be read_pprog:

read_pprog : bool, optional
    True to read pulse program, False prevents reading.
jjhelmus commented 9 years ago

@mfitzp Good catch! I updated both the parameter and the documentation to use the parameter read_pulsepgram which I think it clearer than either of the other options (and read_pprog is already a function so it cannot be used as a parameter without causing issues). This might require some minor modification of scripts which use the older parameter name. Implemented in commit d396614.

Thanks!