Document how different modules are produced for parsing
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- compilers, documentation
Research direction
Start by reviewing the parsing/unparsing section of pending-documentation.md and tracing how the issue's LANGUAGE-PARSING and _$SYNTAX modules are produced. Document each implicitly created module, how it is created, and what it is used for; the issue is complete when this list is added here or to the appropriate documentation section.
Written by the indexing model from the issue text.
Description
Right now we have lots of different ways that new modules are produced for parsing. Every time there is a change to the parsing logic, it's often complicated by the fact that not everyone understands how these implicit modules are created.
For example, the LANGUAGE-PARSING module is a custom module that is created for parsing programs in the language. How is it constructed? What can it be used for? Another example is the _$SYNTAX modules created for each module in the definition.
It would be good to list the modules that are created implicitly and added to the definition, along with (i) how they are created, and (ii) what those modules can be used for.
I think just adding the list here to this issue should be OK, or if it seems appropriate to add it to the parsing/unparsing section of pending-documentation.md it can be added there.
- Dominant language
- Python
- Stars
- 591
- Forks
- 163
- PR merge metrics
- No merged PRs in 30d
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from runtimeverification/k
-
runtimeverification/k#4939 · 1 assignee ·
-
Concolic Explorer Open
Difficulty 5/5 Over a week Newbie friendliness 32/100
runtimeverification/k#4937 ·
-
Difficulty 5/5 Over a week Newbie friendliness 30/100
runtimeverification/k#4936 ·
-
type:epic
runtimeverification/k#4934 · 4 comments · 1 assignee ·
-
runtimeverification/k#4924 · 1 assignee ·
All issues in runtimeverification/k
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100