lambdaclass / lambdaclass/lambda_compiler_kit

nit: fix misleading traversal-order comments in Syntax.lean and Parser.lean

Open Beginner friendly
#26 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

Problem

Comments in Lck/Json/Syntax.lean:151-153 and Lck/Json/Parser.lean:68-70 describe traversal order inaccurately. The actual traversal is right-to-left (tail processed first), but the comments do not reflect this.

Expected fix

Update the comments to accurately describe that elements are processed tail-first (right-to-left order), matching the actual implementation.

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

Start by reading the comments at Lck/Json/Syntax.lean:151-153 and Lck/Json/Parser.lean:68-70, then compare them with the traversal implementation. Update both comments to state that processing is tail-first, in right-to-left order. The issue is done when the comments accurately match the implementation.

Written by the indexing model from the issue text.

Assessment

Domain
compilers
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.