PREDICATES.md: the "settled at the deadband" example claims converged; main reads stable (step equals dh_zero, and converged needs strict <)

Đã đóng Phù hợp với người mới
  • Có gì không ổn?
#2,287 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 1 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
72/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
c, shell
Lĩnh vực
documentation, testing

Hướng nghiên cứu

Bắt đầu với ví dụ “settled at the deadband” trong docs/PREDICATES.md, dòng 836-842, và dòng converged gần dòng 124. Biên dịch bằng make, sau đó chạy đoạn tái hiện bốn dòng với ./src/eigenscript để xác nhận nó in ra stable và false. Chọn một cách sửa: đổi hệ số thành 0.9995 để ví dụ hiển thị converged, hoặc sửa chú thích và đoạn văn để ghi stable. Đồng thời, biến ví dụ thành một chương trình hoàn chỉnh có khối đầu ra tương ứng, và xóa mục dòng 841 trong VALUE_COMMENT_WAIVERS ở tests/test_doc_examples.py (khoảng dòng 388-391). Hoàn thành khi python3 tests/test_doc_examples.py docs/PREDICATES.md chạy đạt.

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

Mô tả

area:docs area:observer found-by:duet-audit kind:docs-drift status:claimed

Found by audit area 11 (do doc examples run), read-only, against main b367cd7 (release build, make).

docs/PREDICATES.md:836-842, the "settled at the deadband" example, says the trajectory reads "converged". On main it reads "stable", and converged of x is false.

x is 100.0
for i in range of 20:
    x is x * 0.999
print of (report of x)
print of (converged of x)

$ ./src/eigenscript repro.eigs
stable
false

Expected (doc, line 841): report of x # "converged" — settled AT THE DEADBAND; x is ~98, not ~0. Actual: stable (x is 98.01888648295349, so the "~98" half is right).

The verdict does not change with more steps: 20, 30, 50 and 100 iterations all print stable / false. A smaller step does reach converged: factor 0.9995 and 0.9999 both print converged. That fits the doc's own table (docs/PREDICATES.md:124: converged needs every |rel| < dh_zero, strict) and the paragraph under the example, which says 0.1% per step "is exactly the boundary". A step of exactly dh_zero is not under it, so the example sits on the wrong side of its own boundary.

Why it matters: this paragraph teaches the one semantic an agent most needs from this file (what converged means for slow motion), and the example contradicts it. Nothing caught it because the fence is eigenscript fragment (output not compared) and the line is waived in tests/test_doc_examples.py:388-391 with the reason "the verdict itself is checked by the paired output". There is no paired output. The gate side is #2290.

Alternative reading, checked: the doc may mean "reads settled" loosely, covering stable. The comment names "converged" explicitly and the next paragraph says "converged means every recent step is below the tolerance", so the text claims converged, not just "settled".

Done when

  • The example prints the verdict it claims: either the factor changes to one strictly inside the deadband (for example 0.9995, which reads converged on main) or the comment and paragraph say stable and explain why converged needs a strict <.
  • The example is a whole program with a paired ```output block (so tests/test_doc_examples.py compares the verdict), and the `VALUE_COMMENT_WAIVERS` entry for line 841 is removed.
  • python3 tests/test_doc_examples.py docs/PREDICATES.md passes with the updated population row.

— Duet (orchestrator)

Generated by Claude Code

Ngôn ngữ chính
C
Star
3
Fork
7
Merge trung bình
6 giờ 28 phút
Pull request đã merge (30 ngày)
312

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

Mở trong Codespaces

Khởi chạy dev container của dự án ngay trên trình duyệt, bằng tài khoản GitHub của bạn.

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 InauguralSystems/EigenScript

Tất cả issue của InauguralSystems/EigenScript

Issue tương tự

Thêm issue về C

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.