Incorrect tip/example for nifgen.session.create_waveform_numpy()
Open
Nobody has claimed this yet.
docs
nifgen
- Dominant language
- Python
- Stars
- 128
- Forks
- 110
- Avg merge
- 5d 14h
- Merged PRs (30d)
- 10
Description
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()?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked nifgen.session.create_waveform_numpy() documentation page and inspect the code line under the “tip” section. Compare the referenced create_waveform() example with the create_waveform_numpy() API, then confirm the rendered documentation shows the intended reference. Done means the tip contains the correct example or the existing reference is confirmed as intentional.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100