runtimeverification / runtimeverification/mir-semantics
Split `ty.md`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 52
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
ty.md models types from both stable_mir::ty and stable_mir_json::printer (in particular, TypeMetadata). As a consequence, to avoid circular dependencies, things get pulled into ty.md that otherwise would belong to other K files.
For example:
stable_mir::abi -> stable_mir::ty
stable_mir_json:::printer -> stable_mir::abi
stable_mir_json:::printer -> stable_mir::ty
Hence ty.md defnies sorts that would belong to abi.md (e.g. LayoutShape).
The solution is to model Rust modules more faithfully and introduce a separate module for stable_mir_json data.
Contributor guide
No contributing guide indexed for this repository
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.
Research direction
Start by reading ty.md and comparing its stable_mir::ty and stable_mir_json::printer models, then inspect abi.md for definitions such as LayoutShape. Trace the dependency examples in the issue. Done means Rust modules are modeled more faithfully and stable_mir_json data has its own module without the described circular dependencies.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100