lambdaclass / lambdaclass/lambda_compiler_kit

nit: several low-priority polish items in JSON parser (decimal rendering, ordering invariant, docstrings)

Abierto
#23 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Lean
Estrellas
2
Forks
1
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Items

These are low-priority nits flagged by AI code review on PR #8. Grouping them into a single issue to keep the tracker clean.

1. Decimal rendering precision (cli/LckJsonFmt.lean:30)

The renderNumber function may truncate fractional digits beyond 20 decimal places, losing round-trip fidelity for numbers with high precision.

2. Dependent types for ordering invariant (Lck/Json/Syntax.lean:444-450)

SortedKVs currently enforces its key-sorted ordering invariant by convention. Using dependent types (a sigma type or a subtype with a Sorted proof) would make the invariant enforcement compile-time rather than runtime.

3. Missing docstrings (Lck/Json/Parser.lean)
  • convOfPolicy: no docstring explaining what it does or why it exists
  • SortedKVs.ofList: no documentation of the byte-lexicographic key ordering behavior
  • Consider making convOfPolicy private to reduce public API surface

References

  • Flagged by AI code review on PR #8

Guía de contribución

No hay ninguna guía de contribución indexada para este repositorio

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.

Línea de trabajo

Lee primero las tres áreas indicadas: cli/LckJsonFmt.lean:30, Lck/Json/Syntax.lean:444-450 y Lck/Json/Parser.lean. Separa las propuestas de precisión, invariancia del orden y documentación antes de decidir su alcance; darlo por terminado requeriría una resolución acordada para cada elemento enumerado, incluida la cuestión de la visibilidad de la API de convOfPolicy.

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

Evaluación

Área
compilers
Tipo de issue
Refactorización
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.