Baseflow / Baseflow/flutter_cache_manager
Document getFileStream.key parameter
- Ngôn ngữ chính
- Dart
- Star
- 809
- Fork
- 510
- Merge trung bình
- 6 phút
- Pull request đã merge (30 ngày)
- 1
Mô tả
## 🏗 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.
Hướng dẫn đóng góp
Hướng nghiên cứu
Bắt đầu bằng cách tìm API getFileStream và tài liệu Config trong package này, sau đó đọc mã nguồn để xác nhận tham số key điều khiển điều gì. Ghi lại rõ ràng hành vi đó, bao gồm điểm khác biệt so với cacheKey của CachedNetworkImage, và xác minh rằng tài liệu API công khai hiện đã giải thích tham số này.
Do mô hình lập chỉ mục viết ra từ nội dung của issue.
Đánh giá
- Công nghệ
- dart, flutter
- Lĩnh vực
- documentation
- Loại issue
- Tài liệu
- Độ khó
- 1/5
- Thời gian dự kiến
- Dưới một giờ
- Mức độ hoạt động
- Đình trệ
- Độ rõ ràng
- Khá rõ ràng
- Mức phù hợp với người mới
- 55/100