modify newSpecFile() API

bluesky / hklpy

Diffractometer computation library with ophyd pseudopositioner support

https://blueskyproject.io/hklpy

BSD 3-Clause "New" or "Revised" License

4 stars 12 forks source link

modify newSpecFile() API #175

Open prjemian opened 3 years ago

prjemian commented 3 years ago

@rodolakis suggest that the call to hkl.user.newSpecFile() be changed a bit:

the default of scan_id kwarg should not be 1 (maybe this should be a required argument?)
the newSpecFile() command should report what it is doing
a new kwarg could be added to skip the reporting

prjemian commented 3 years ago

In separate conversation, we agreed that scan_id should remain a kwarg but with default of None so the user does not have to retrieve the current scan ID (as RE.md["scan_id"]) and figure out if they should +1 to it or not. Schematically, the new handling (with scan_id=None) will be:

if scan_id is None:
    # pick up from the last scan_id
else:
    # use the scan_id just provided

prjemian commented 3 years ago

The new kwarg to be added to skip the reporting could be either verbose=True or quiet=False. Be consistent with other use here in hklpy and throughout Bluesky projects.

To me, the quiet=False alternative sounds (almost) like a double negative.

rodolakis commented 3 years ago

I do find the quiet=False confusing at time; verbose=True is better.