API: Move command module into parametes and undocument #4286
Conversation
Codecov Report
@@ Coverage Diff @@
## master #4286 +/- ##
==========================================
- Coverage 68.40% 68.39% -0.02%
==========================================
Files 249 251 +2
Lines 30941 30943 +2
==========================================
- Hits 21166 21164 -2
- Misses 9775 9779 +4 |
There was a problem hiding this comment.
move Function into Parameters where it more naturally belongs
could you share the reasoning behind this? i'm happy to share mine: it seems to me that Function belongs to the Instruments because it's an instrument-specific feature, and does not relate to parameters at all. Parameters don't use it and Functions dont use parameters, however Instruments use Functions and Function is means to live on an instrument (even as per it's docstring). Command on the other hand is indeed a thing that only Parameters happen to use, so Command belonging to Parameters makes a lot of sense (and it's not a package-scope utility, which is the original motivation of the PR, right?).
Both parameters and functions are things that the instrument uses at exactly the same level. 1Both make use of Command so it makes sense to group all of these things together. In reality functions is a limited version of a parameter. I agree that the nameing of the module paraemters is not optimal from this way but since Functions is a minor thing that we really want to get rid of and deprecate (or at least strongly discourage the use of) I am not to worried |
arggh, missed that Function uses Command. ok, no things make sense, thanks! |
|
Also see #4292 which should fully eliminate the use of Functions |
|
bors merge |
To make this possible also move Function into Parameters where it more naturally belongs