CliMA / CliMA/EnsembleKalmanProcesses.jl

For every struct, overload Base.show() and Base.summary()

Open
#422 0 comments 1 reaction 0 assignees View on GitHub
Dominant language
Julia
Stars
125
Forks
24
Avg merge
1d 18h
Merged PRs (30d)
5

Description

## Issue
Some of the distributions and objects are very unwieldy especially when printing to terminal IO

## Possible Solution
Inspiration: @glwagner at Oceananigans.jl
- Providing `Base.show()` methods (and improving those that currently exist) would improve the user experience in the REPL.
- Also look into `Base.summary()` functions which can provide something cleaner than `nameof(typeof(...))` calls in error messaging etc.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inventorying the distributions and objects that are unwieldy in terminal output, then inspect any existing Base.show methods and the relevant Base.summary behavior. Compare REPL output and error-message summaries for each struct; done means every struct has appropriately concise, useful display behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
developer-experience
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.