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

DOC: specify k2700 cpts are for ranges #1174

Merged
merged 2 commits into from
Oct 11, 2023
Merged

DOC: specify k2700 cpts are for ranges #1174

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
18a190d
DOC: specify k2700 cpts are for ranges
Oct 9, 2023
ec934f3
DOC: added component name changes to API Break section of release notes
Oct 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions docs/source/upcoming_release_notes/1174-k2700_specify_cpts_are_for_ranges.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
1174 k2700_specify_cpts_are_for_ranges
#################

API Breaks
----------
- K2700.dcv renamed to K2700.dcv_range
- K2700.acv renamed to K2700.acv_range
- K2700.dci renamed to K2700.dci_range
- K2700.aci renamed to K2700.aci_range

Features
--------
- N/A

Device Updates
--------------
- Added 'range' to names/docs of dcv, acv, dci, and aci components of K2700

New Devices
-----------
- N/A

Bugfixes
--------
- N/A

Maintenance
-----------
- N/A

Contributors
------------
- N/A
16 changes: 8 additions & 8 deletions pcdsdevices/pim.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,14 +572,14 @@ class K2700(BaseInterface, Device):
doc='Identity (name) of this device')
reading = Cpt(EpicsSignalRO, ":Reading", kind="normal",
doc='Trigger and return a new measurement')
dcv = Cpt(EpicsSignalRO, ":GetDCV", kind="normal",
doc='DC voltage')
acv = Cpt(EpicsSignalRO, ":GetACV", kind="normal",
doc='AC voltage')
dci = Cpt(EpicsSignalRO, ":GetDCI", kind="normal",
doc='DC current')
aci = Cpt(EpicsSignalRO, ":GetACI", kind="normal",
doc='AC current')
dcv_range = Cpt(EpicsSignalRO, ":GetDCV", kind="normal",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So this is technically a sort of "API Break", since we're changing the name of a component on this device. If there are older scripts that expect K2700.dcv, they won't be able to find that name any longer.

Practically, if you know you're the only one using this device and you won't break others' usage of the device, this is fine. I just want to make sure this is the case.

If it were me I'd update the documentation alone, but that may be out of an abundance of caution

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the clarification, release notes have been updated to note the API breaks. I recently added this device class and there aren't any happi entries using it other than one I made so it should be safe to change the component names.

doc='DC voltage range')
acv_range = Cpt(EpicsSignalRO, ":GetACV", kind="normal",
doc='AC voltage range')
dci_range = Cpt(EpicsSignalRO, ":GetDCI", kind="normal",
doc='DC current range')
aci_range = Cpt(EpicsSignalRO, ":GetACI", kind="normal",
doc='AC current range')


class IM3L0_K2700(K2700):
Expand Down