Slight clarification in the ImageCache docs #33195
Conversation
It was easy to miss the reference to the top-level `imageCache` property before. This calls out the property a little more explicitly.
| /// subclasses automatically handle the caching of images. | ||
| /// | ||
| /// A shared instance of this cache is retained by [PaintingBinding] and can be | ||
| /// obtained via the [imageCache] top-level property. |
There was a problem hiding this comment.
Should this be [PaintingBinding.imageCache] so it links directly there? As fas as I can tell, The ImageCache class does not have an imageCache property, right?
There was a problem hiding this comment.
It's a top-level property -- https://api.flutter.dev/flutter/painting/imageCache.html
It was actually linked in the docs before too, but the way it was structured, I missed the link.
There was a problem hiding this comment.
You are of course right, I think I was confused by the mentioning of PaintingBinding in the previous sentence and assumed you must mean the imageCache property on that thing.
Maybe you could clarify that [imageCache] is a top-level property in the painting library (https://master-api.flutter.dev/flutter/painting/painting-library.html). But it's also fine as is as the link will actually go to the right thing...
| /// subclasses automatically handle the caching of images. | ||
| /// | ||
| /// A shared instance of this cache is retained by [PaintingBinding] and can be | ||
| /// obtained via the [imageCache] top-level property. |
There was a problem hiding this comment.
You are of course right, I think I was confused by the mentioning of PaintingBinding in the previous sentence and assumed you must mean the imageCache property on that thing.
Maybe you could clarify that [imageCache] is a top-level property in the painting library (https://master-api.flutter.dev/flutter/painting/painting-library.html). But it's also fine as is as the link will actually go to the right thing...
Description
It was easy to miss the reference to the top-level
imageCacheproperty before. This calls out the property a little more
explicitly.
Tests
N/A
Checklist
///).flutter analyze --flutter-repo) does not report any problems on my PR.Breaking Change
Does your PR require Flutter developers to manually update their apps to accommodate your change?