Arguments of make_block_pulse are highly confusing

imr-framework / pypulseq

Pulseq in Python

https://pypulseq.readthedocs.io

GNU Affero General Public License v3.0

111 stars 58 forks source link

Arguments of make_block_pulse are highly confusing #149

Closed wtclarke closed 7 months ago

wtclarke commented 7 months ago

bandwidth, the second listed argument (default=0) has no effect (see relevant logic), unless the the default to duration (default = 4E-3) is overwritten by the user. This isn't documented anywhere, no warning is issued, and duration is listed several places below bandwidth in the list of arguments.

sravan953 commented 7 months ago

Thanks for this, @wtclarke ! Would you be interested in submitting a PR wherein a warning is raised?

wtclarke commented 7 months ago

Done in #151 . I've also added markers for the tests, so only the tests we expect to work will run.

wtclarke commented 7 months ago

Closed in #151