lowRISC / lowRISC/dvsim

Tidy up the name of Deploy.sim_cfg

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

Nobody has claimed this yet.

enhancement
Dominant language
Python
Stars
13
Forks
21
Avg merge
1d 11h
Merged PRs (30d)
8

Description

... since it's not actually a SimCfg!

A trivial (but slightly noisy) change is to rename it to `flow_cfg`. While we're doing that, we can also get rid of the rather ugly `_typed_sim_cfg` that I had to add to some of the classes (and call that just `sim_cfg`).

@AlexJones0 had some further ideas of how to do this cleanly in [this comment](https://github.com/lowRISC/dvsim/pull/153#discussion_r3030552948).

Contributor guide

Open the contributing guide

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

Locate the Deploy.sim_cfg and _typed_sim_cfg definitions and their references, then read the linked pull request discussion for the suggested cleanup. Rename Deploy.sim_cfg to flow_cfg and replace _typed_sim_cfg with sim_cfg where appropriate; done means all references are consistent and the existing checks pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
build-system
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.