Improve consistency in LogLocator and LogFormatter API #23014
Merged
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
oscargus
force-pushed
the
tickerconsistency
branch
2 times, most recently
from
9f8edef to
6673be2
Compare
oscargus
force-pushed
the
tickerconsistency
branch
from
6673be2 to
1bc33e9
Compare
jklymak
reviewed
May 16, 2022
| # FIXME: these base and subs functions are contrary to our | ||
| # usual and desired API. | ||
|
|
||
| @_api.deprecated("3.6", alternative='set_params(base=...)') | ||
| def base(self, base): |
There was a problem hiding this comment.
Is there a reason to not have set_base and set_subs here?
There was a problem hiding this comment.
My impression is that locators only supply set_params and no methods for individual parameters. (As opposed to formatters where separate methods seems like the standard.)
jklymak
approved these changes
May 18, 2022
QuLogic
approved these changes
Jun 21, 2022
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.
PR Summary
Earlier
LogFormatterandLogLocatorhad a bit of an usual API to set parameters. This deprecates those and introduce alternative methods.Will add a change note once I realize if any tests are failing and I get a PR number.Done!PR Checklist
Tests and Styling
pytestpasses).flake8-docstringsand runflake8 --docstring-convention=all).Documentation
doc/users/next_whats_new/(follow instructions in README.rst there).doc/api/next_api_changes/(follow instructions in README.rst there).