Example config files omit the `presence:` block the parser accepts

Đang mở Phù hợp với người mới
#60 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
2/5
Thời gian dự kiến
1-3 giờ
Mức phù hợp với người mới
69/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
rust
Lĩnh vực
documentation

Hướng nghiên cứu

Đọc crates/podd-core/src/config/mod.rs để xem các trường của PresenceConfig và ARCHITECTURE.md để nắm ngữ cảnh API. Sau đó, kiểm tra config.example.ron, config.pod3.example.ron và config.pod4.example.ron để xem các tùy chọn được ghi tài liệu như thế nào. Công việc hoàn tất khi các ví dụ giải thích cả ba trường presence trong một khối chú thích hoặc nêu rõ rằng presence chỉ có trong thời gian chạy.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

documentation good first issue

crates/podd-core/src/config/mod.rs defines Config.presence: Option<PresenceConfig> (fields baselines: [u16;6], threshold: u16, debounce_count: u8), and ARCHITECTURE.md documents a GET/POST /metrics/presence API around it, but none of config.example.ron, config.pod3.example.ron, or config.pod4.example.ron mention presence at all. A user has no documented way to discover or shape this option. Add a commented-out presence: (...) block (with the three fields and their meaning) to the example configs, or explicitly note it's runtime-only.


Filed from a repo-wide code audit (working tree at bcad746).

Ngôn ngữ chính
Rust
Star
0
Fork
0
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của GoogleBot42/podd

Tất cả issue của GoogleBot42/podd

Issue tương tự

Thêm issue về Rust

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.