AddHeatMapCoordinated → AddHeatmapCoordinated#963
Merged
swharden merged 3 commits intoScottPlot:masterfrom Apr 10, 2021
Merged
Conversation
Member
|
Hi @bclehmann, I agree with this - thanks for the PR! Also I learned about |
48 tasks
to prevent these lines from appearing to be modified by PR ScottPlot#963
swharden
changed the title
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
2 participants
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.
New Contributors:
please review CONTRIBUTING.md
Purpose:
#955
This renaming preserves the previous method signature but marks it as obsolete. The warning points to the new method.
I also used
[EditorBrowsable(EditorBrowsableState.Never)]so that IDEs which respect this attribute will not show it in code completion. Note it will always be shown on the ScottPlot assembly, but not in projects which use the library. I think this attribute can be controversial, I'm using it here because the previous method signature is nearly identical and does the same thing, which can make the two difficult to differentiate. I wouldn't use this attribute on obsolete methods likePlotHeatmapbecause that method does actually do something different and thus shouldn't be hidden. I think it's okay in this case since anyone who is looking forAddHeatMapCoordinatedshould useAddHeatmapCoordinatedand they wouldn't notice the difference, while still protecting people from accidentally using the deprecated method through code completion.There was discussion on #955 about refactoring the heatmap plottables and potentially adding other scaling options such as cropping, zooming, scaling only one axis, etc. That might be interesting for a future PR, depending on your opinion.
New Functionality:
N/A