julia-mpsge/MPSGE.jl

Rewrite Markusen examples using Literate.jl

Aberta

#200 aberto em 27 de mai. de 2025

Ver no GitHub
 (0 comentário) (0 reação) (1 responsável)Julia (3 forks)auto 404
documentationgood first issue

Métricas do repositório

Stars
 (22 estrelas)
Métricas de merge de PR
 (Mesclagem média 57d 8h) (4 fundiu PRs em 30d)

Description

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.

Guia do colaborador

Direção de pesquisa
Estude a documentação do Literate.jl e converta cada notebook Jupyter para um arquivo .jl com as células markdown como comentários. Garanta que os exemplos sejam incluídos na documentação por meio das funções `notebook` ou `markdown` do Literate.jl e adicione doctests para executá los como testes.
Pilha de tecnologia
julia
Domain
documentationtesting
Tipo Issue
Refatoração
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
JuliaLiterate.jl
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60