Baseflow / Baseflow/flutter_cache_manager

Document getFileStream.key parameter

オープン
#344 コメント 1 件 リアクション 2 件 担当者 0 名 GitHub で見る
主要言語
Dart
スター
809
フォーク
510
平均マージ
6分
マージ済み PR(30日)
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 を短くまとめたダイジェスト。