search

Baseflow / flutter_cache_manager

Generic cache manager for flutter
https://baseflow.com
MIT License
749 stars 438 forks source link

Document getFileStream.key parameter #344

Open DeD1rk opened 2 years ago

DeD1rk commented 2 years ago

🏗 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.

rivella50 commented 2 years ago

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.