lambdaclass / lambdaclass/lambda_compiler_kit

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

Open
#23 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Lean
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

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

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the three named areas first: cli/LckJsonFmt.lean:30, Lck/Json/Syntax.lean:444-450, and Lck/Json/Parser.lean. Separate the precision, ordering-invariant, and documentation proposals before deciding their scope; done would require an agreed resolution for each listed item, including the API-visibility question for convOfPolicy.

Written by the indexing model from the issue text.

Assessment

Domain
compilers
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.