julia-mpsge/MPSGE.jl

Rewrite Markusen examples using Literate.jl

開放

#200 建立於 2025年5月27日

在 GitHub 查看
 (0 則留言) (0 個反應) (1 位負責人)Julia (3 個分叉)auto 404
documentationgood first issue

倉庫指標

星標
 (22 顆星)
PR 合併指標
 (平均合併 57天 8小時) (30 天內合併 4 個 PR)

描述

Issue

Currently the Markusen examples (in the examples directory) use Jupyter notebooks. It will be better to have these as standard Julia files.

Solution

Write the Markusen examples so that

  1. They formatted to satisfy Literate.jl
  2. Include in documentation
  3. Run examples as tests (using doctest) to ensure they always work.

貢獻者指南

研究方向
研究 Literate.jl 的文檔，並將每個 Jupyter 筆記本轉換為 .jl 檔案，其中 markdown 儲存格作為註解。確保透過 Literate.jl 的 `notebook` 或 `markdown` 函式將範例包含在文件中，並新增 doctest 以作為測試執行。
技術棧
julia
領域
documentationtesting
議題類型
重構
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
2
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
半天
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
JuliaLiterate.jl
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60