flutter_cache_manager icon indicating copy to clipboard operation
flutter_cache_manager copied to clipboard

Document getFileStream.key parameter

Open DeD1rk opened this issue 4 years ago • 1 comments

🏗 Enhancement Proposal

Some methods such as getFileStream have a key parameter. This is very useful in some cases, but is not documented. I suggest adding a little bit of documentation about that parameter.

I'm creating this issue because I myself had to look at the source code to make sure that the parameter does what I expect from it. Specifically, I was looking at the cacheKey parameter of CachedNetworkImage in https://github.com/Baseflow/flutter_cached_network_image. This is named unclearly, because the same name is used as a parameter in Config in this package, with a completely unrelated meaning. Of course documentation should also be added in that package.

Pitch

More complete documentation makes this package easier to use correctly.

DeD1rk avatar Nov 02 '21 15:11 DeD1rk

I do fully agree. I would like to use this plugin but i am completely lost since there is almost no current documentation nor some good examples around.

rivella50 avatar Mar 30 '22 06:03 rivella50