fix: update applyColour documentation #6998
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
I have no idea why it would be doing that. Added here: c868a86#diff-8bc430f306f183ee3e55aa995c55063f906fe1ac043571db11d15b67566c3012R329 |
NeilFraser
approved these changes
Apr 21, 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.
The basics
npm run formatandnpm run lintThe details
Resolves
Missing documentation from reference pages.
Proposed Changes
@internaltag fromapplyColourmethods in fields. This method is not@internalbecause it can be overridden by subclasses. Therefore it should appear in our documentation.BlockSvg.applyColourbecause this method is already called byinput.tsas well plusFieldDropdowncalls its own method several times, and this makes sense, because you only want to update that kind of style information in one method, so it's a pattern other fields might follow.Behavior Before Change
Behavior After Change
Reason for Changes
Test Coverage
Documentation
Additional Information
FieldDropdowncalls this method in itsdisposemethod, is that weird? If we're disposing the element I don't know why we'd also be updating some (now-irrelevant) styles on it but I didn't look too deeply into this as I'm not making any code changes here