Baseflow / Baseflow/flutter_cache_manager

Document getFileStream.key parameter

未关闭
#344 1 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看
主要语言
Dart
星标
809
派生
510
平均合并
6 分钟
30 天内合并 PR
1

描述

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

贡献指南

打开贡献指南

调研方向

先在此软件包中定位 getFileStream API 和 Config 文档,然后阅读源代码以确认 key 参数控制的内容。清楚地记录该行为,包括它与 CachedNetworkImage 的 cacheKey 有何不同,并验证公共 API 文档现在已经解释了该参数。

由索引模型根据 Issue 内容生成。

评估

技术栈
dart, flutter
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
基本清楚
新手友好度
55/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。