MagneticResonanceImaging/MRIReco.jl

Fix and enhanced documentation

Open

#211 opened on Dec 11, 2024

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Julia (24 forks)auto 404
documentationgood first issue

Repository metrics

Stars
 (97 stars)
PR merge metrics
 (Avg merge 65d 23h) (1 merged PR in 30d)

Description

To fix :

  • API #188
  • Examples #198 #189 -> PR WIP #212
  • params[:ρ] = 1 -> params[:rho] = 1
  • fix coil sensitivity maps for example

To add :

Should we try to run most of the example during the CI and perform a doctest if it fails ?

Contributor guide

Research direction
Review the MRIReco.jl documentation structure and the linked issues to understand the current state. Choose a specific task (e.g., fixing a broken API reference or adding the switch to Makie) and implement the change. Run the local Julia tests to ensure nothing breaks.
Tech stack
julia
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
JuliaGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50