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.

Sign up for GitHub

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

Jump to bottom

Rename Run to Shot #81

Open
philipstarkey opened this issue Nov 3, 2020 · 2 comments · May be fixed by #85
Open

Rename Run to Shot #81

philipstarkey opened this issue Nov 3, 2020 · 2 comments · May be fixed by #85

Comments

@philipstarkey
Copy link
Member

The Run class is poorly named. It should really be Shot. I propose we rename, and add the following class for backwards compatibility until v4.0

import warnings
class Run(Shot):
    def __init__(self, *args, **kwargs):
        warnings.warn("The 'Run' class has been renamed to 'Shot' (but is otherwise compatible). 'Run' will be removed in lyse v4.0. Please update your analysis code to use the 'Shot` class", DeprecationWarning)
        super().__init__(*args, **kwargs)
@chrisjbillington
Copy link
Member

Very yes.

Runmanager -> shotmanager? More entrenched, maybe :p

@philipstarkey
Copy link
Member Author

Runmanager -> shotmanager? More entrenched, maybe :p

Paramanager? Paramager?

(no I'm not being serious!)

philipstarkey added a commit to philipstarkey/lyse that referenced this issue Nov 5, 2020
@philipstarkey
Renaming Run to Shot
86d9cda 
Resolves Rename Run to Shot labscript-suite#81

Renamed classes/arguments/docs from run to shot and added dprecation notices where appropriate.

Arguments (distinct from keyword arguments) were renamed without worrying about backwards compatibility under the assumption that people are not using them as keyword arguments (which is technically possible).
@philipstarkey philipstarkey linked a pull request Nov 5, 2020 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Renaming Run to Shot philipstarkey/lyse
2 participants
@chrisjbillington @philipstarkey