docs: document occasional mismatch between NSImageName and string #17826
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 of Change
Fixes #17785.
In some cases, the
NSImageName
doesn't match its string representation; one example of this isNSFolderImageName
, whose string representation would actually beNSFolder
. Therefore, you'll need to determine the correct string representation for your image before passing it in. This documents that need.cc @nornagon
Checklist
Release Notes
Notes: Documented an issue with
nativeImage.createFromNamedImage
where the string representations of NSImageName might not match theNSImageName
.