ni / nimi-python

Python bindings for NI Modular Instrument drivers.
Other
112 stars 84 forks source link

Incorrect tip/example for nifgen.session.create_waveform_numpy() #2018

Open gfisher-NI opened 11 months ago

gfisher-NI commented 11 months ago

Description of issue

In the documentation for nifgen.session.create_waveform_numpy(), the example line of code code under 'tip' just references nifgen.session.create_waveform(). Is this correct or should it instead reference nifgen.session.create_waveform_numpy()?

create_waveform_numpy

marcoskirsch commented 11 months ago

There is no create_waveform_numpy method. So there should be no documentation for it. There is a create_waveform method. So it is a problem that it is not documented!

Documentation is generated from metadata (like most of these APIs), and create_waveform is what we call "a fancy method" which means it's one of the few we handcode for usability. Evidently we messed some of it up.