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

Cerrado Apto para principiantes
  • ¿Algo no está bien?
#2,287 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
72/100
Tipo de issue
Documentación
Claridad
Bastante claro
Estado de actividad
Activo
Stack tecnológico
c, shell
Área
documentation, testing

Línea de trabajo

Empieza con el ejemplo “settled at the deadband” en docs/PREDICATES.md, líneas 836-842, y con la fila de converged cerca de la línea 124. Compila con make, luego ejecuta la reproducción de cuatro líneas contra ./src/eigenscript y confirma que imprime stable y false. Elige una corrección: cambiar el factor a 0.9995 para que el ejemplo muestre converged, o corregir el comentario y el párrafo para que digan stable. Además, convierte el ejemplo en un programa completo con un bloque de salida emparejado y elimina la entrada de la línea 841 en VALUE_COMMENT_WAIVERS en tests/test_doc_examples.py (alrededor de las líneas 388-391). Terminado cuando python3 tests/test_doc_examples.py docs/PREDICATES.md pase.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
C
Estrellas
3
Forks
7
Merge medio
6 h 28 min
PR fusionados (30 d)
312

Preparar el entorno

Abrir en Codespaces

Inicia el contenedor de desarrollo del proyecto en tu navegador, con tu propia cuenta de GitHub.

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de InauguralSystems/EigenScript

Todos los issues de InauguralSystems/EigenScript

Issues similares

Más issues de C

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.