julia-mpsge/MPSGE.jl

Rewrite Markusen examples using Literate.jl

Aperta

#200 aperta il 27 mag 2025

Vedi su GitHub
 (0 commenti) (0 reazioni) (1 assegnatario)Julia (3 fork)auto 404
documentationgood first issue

Metriche repository

Star
 (22 stelle)
Metriche merge PR
 (Merge medio 57g 8h) (4 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Studia la documentazione di Literate.jl e converti ogni notebook Jupyter in un file .jl con le celle markdown come commenti. Assicurati che gli esempi siano inclusi nella documentazione tramite le funzioni `notebook` o `markdown` di Literate.jl e aggiungi i doctest per eseguirli come test.
Tech stack
julia
Dominio
documentationtesting
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
JuliaLiterate.jl
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60