Update docstrings formatting refactor #255
Open
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
vsoch
reviewed
Jun 14, 2023
| value: the value to set, if filter_name is valid | ||
|
|
||
| """ | ||
| if "0x" in field: | ||
| field = int(field, 0) # 0=decode hex with 0x prefix | ||
| filter_name = filter_name.lower().strip() | ||
| filter_name_map = { |
There was a problem hiding this comment.
I see what you are trying to do, but this design isn't an improvement because in creating the dictionary you are executing each function. We definitely don't want to do that.
There was a problem hiding this comment.
If you’d like to revert this change, the docstring fixes are great and would be much appreciated!
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
This PR submits several minor formatting and docstring changes and one change to the logic of a function using multiple conditionals to use a dictionary instead. No changes are part of a current issue.
Related issues: # (issue)
None
Please include a summary of the change(s) and if relevant, any related issues above.
There are changes to several docstrings in the file (tags.py) to add parameters, formatting to reduce line lengths >100 chars, and one change to the function apply_filter() in filter.py to use dict map instead of conditionals.
Checklist
Open questions
Questions that require more discussion or to be addressed in future development:
None. Thanks for reviewing!