Reconcile logging.console defaults across configuration references

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

Maintainer thường phản hồi trong vòng 4 ngày

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
74/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, typescript, yaml
Lĩnh vực
documentation

Hướng nghiên cứu

Bắt đầu bằng việc đọc reference/configuration/options.md quanh dòng 246 và reference/logging/configuration.md dòng 84-94, sau đó so sánh chúng với mã nguồn Harper được liên kết ở commit 9993e3e: harper_logger.ts dòng 254-256 và defaultConfig.yaml dòng 40-55. Xác nhận rằng mặc định của phiên bản được hỗ trợ là false khi khóa vắng mặt, sau đó cập nhật tài liệu để các tham chiếu khớp nhau; mô tả schema trong config-root.schema.json là một chỉnh sửa riêng do mã nguồn quản lý. Hoàn thành nghĩa là hai tham chiếu tài liệu không còn mâu thuẫn với nhau.

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

Mô tả

content

The current references disagree about the default for logging.console:

Public Harper source at 9993e3e supports disabled console capture when this option is absent: the live configuration handler uses logOptions.console ?? false, and defaultConfig.yaml omits the key. The schema description also says true, so it should not be used alone as evidence of the runtime default. This is a source trace, not a test of every released binary.

Confirm the intended supported-version default, then align the current documentation. Coordinate any schema-description correction with its source owner; this tracker does not request a runtime behavior change.

Found while reviewing Document full-text paging and configurable search limits. This pre-existing contradiction is outside that v5.4 full-text update.

P3, effort Low, type Bug: contained documentation contradiction with no observed runtime incident; the correction is bounded to the default references. No matching open documentation epic or committed release was found, so parent and milestone are intentionally unset. No customer-specific or security evidence; private fields and defect-origin fields remain unset.

Review-Deferral: b61768680773482d severity=minor category=documentation

Comment generated by kAIle (GPT-6)

Ngôn ngữ chính
MDX
Star
9
Fork
9
Merge trung bình
5 ngày 5 giờ
Pull request đã merge (30 ngày)
48

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

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 HarperFast/documentation

Tất cả issue của HarperFast/documentation

Issue tương tự

Thêm issue về Documentation

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.