0xMiden / 0xMiden/miden-vm

Document values of constants using `insta`

オープン
#2,221 コメント 3 件 リアクション 2 件 担当者 1 名 @Nashtare に割り当て済み GitHub で見る
documentation processor
主要言語
Rust
スター
772
フォーク
352
平均マージ
1日 12時間
マージ済み PR(30日)
93

説明

We currently define many constants which are defined programmatically rather than using "magic numbers". This ensures for example that column indices are properly computed. Unfortunately, this also makes it hard to easily figure out what the values actually are. In my particular workflow, my IDE is not smart enough to actually compute and display the values.

While we should always update the docs whenever we make any changes that might affect things like trace widths and offsets, these must be done manually and are hard to check, and easily lead to outdated documentation.

The codebase is and should be the single source of truth when it comes to specification of our VM. We can make it easier to understand by writing tests using `insta` to document parameters such as
- the widths of all our traces along with their offsets
- the specific range of sets of columns for some chiplets (e.g. capacity portion of RPO inside the hasher chiplet)

The docs could then point to this specific test when trying to understand the structure of the VM.

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。