Add a note that Locators must return ticks above and below vlims #25173
Conversation
This file contains hidden or 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
|
I think it's worth adding one sentence of context here. I tried writing a recommendation, but drew a blank... if I get a bit more time I'll try and dive through the archives of discussing this issue to work out a good sentence. |
|
We should also check that all our locators actually adhere to this before documenting it! I've been having a play around with |
10 tasks
QuLogic
reviewed
Feb 22, 2023
Comment on lines
+21
to
+22
| Locators must return at least a single tick below ``vmin`` and a single tick | ||
| above ``vmax``. |
There was a problem hiding this comment.
Seems like this should be changed to >=/<=, cf #25146 (comment)
story645
reviewed
Oct 31, 2023
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.
Closes #25146
This was made as a demo in the new contributors meeting.
Happy to update wording/add addtional context if we want.
PR Summary
PR Checklist
Documentation and Tests
pytestpasses)Release Notes
.. versionadded::directive in the docstring and documented indoc/users/next_whats_new/.. versionchanged::directive in the docstring and documented indoc/api/next_api_changes/next_whats_new/README.rstornext_api_changes/README.rst