Announce zhinst-toolkit 1.0 #293
Open
+43
−28
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
February 7, 2025 11:45
Adjust the documentation of the deep flag to better reflect the behavior in zhinst-toolkit 1.0.
We decided to bump toolkit to version 1.0. The public interface has been stable for a while and we are committed to keep it so moving forward. This version bump does *not* come with breaking changes in the public interface. Ugprade from 0.x to 1.0 is safe.
fabiorossetto
force-pushed
the
fabior/deep_doc
branch
from
23033c4 to
0516b2d
Compare
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| @@ -66,8 +66,7 @@ | |||
| """ | |||
|
|
|||
| # Required for typing | |||
| def __init__(self, *args, **kwargs): | |||
| ... | |||
| def __init__(self, *args, **kwargs): ... | |||
Check notice
Code scanning / CodeQL
Statement has no effect Note
25.04 changes the behavior of `set` to be fully blocking until device acknowledgement. To have the same behavior in toolkit, the zhinst.core requirement has been bumped.
fabiorossetto
force-pushed
the
fabior/deep_doc
branch
2 times, most recently
from
07895f0 to
eae8e48
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description:
zhinst-toolkithas been stable since version 0.3 and we intend to keep that stability going forward. This is way we have decided to promote the library to version 1.0.Despite the major version bump, this new version does not introduce any breaking change with respect to 0.7. Users can safely upgrade from 0.x to 1.0.
Even if we haven't changed the public interface, there are some differences you should be aware of:
deepflag. Thedeepflag is still available and can be useful if you want to get back the node value after the setting has been applied.This PR also changes the documentation to better reflect the actual behavior of the
deepflag.Fixes issue: #
Checklist: