Fix typo in EncodingVisualizer.annotation_converter attribute#2068
Open
c-tonneslan wants to merge 1 commit into
Open
Fix typo in EncodingVisualizer.annotation_converter attribute#2068c-tonneslan wants to merge 1 commit into
c-tonneslan wants to merge 1 commit into
Conversation
The constructor stashes the optional converter under `self.annotation_coverter` (note the missing 'n') and `__call__` reads from the same misspelled attribute. The keyword argument and the docstring both spell it correctly, so the attribute name didn't match the documented one. Anyone setting `viz.annotation_converter` post-init to swap in a new converter would set a new attribute and the misspelled one would keep being read. Renamed the attribute to match the public spelling. Signed-off-by: Charlie Tonneslan <cst0520@gmail.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Tiny fix found while reading the visualizer code.
`EncodingVisualizer.init` stashes the converter under `self.annotation_coverter` (missing 'n'), and `call` reads from the same misspelled attribute. The keyword argument and the docstring both spell it correctly, so the public name and the attribute name don't match. Anyone trying to set or read `viz.annotation_converter` after instantiation would silently end up with a separate attribute, while the misspelled one keeps being used internally.
Renamed the attribute to match the public spelling. No behavior change otherwise, just makes `self.annotation_converter` actually do what its name says.