Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
gfisher-NI opened this issue Sep 21, 2023 · 1 comment
Open

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

gfisher-NI opened this issue Sep 21, 2023 · 1 comment

Comments

@gfisher-NI
Copy link
Contributor

gfisher-NI commented Sep 21, 2023

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
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants