kynan/nbstripout

Option to error on cell outputs exceeding `--max-size`

Open

#167 opened on Aug 19, 2022

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Python (90 forks)batch import
help wantedtype:enhancement

Repository metrics

Stars
 (1,047 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

The --max-size flag added in #135 is a great addition! 👍

When using nbstripout as commit hook, it would be nice to have a slightly safer mode that doesn't auto-remove output exceeding the max size but rather raises an error to abort the commit and let the developer handle it on a case by case basis (maybe compress rather than remove the cell output).

Contributor guide

Research direction
Investigate the current implementation of the max size flag added in PR #135, understand how nbstripout currently handles cell output size, and implement a new flag (e.g., error on max size) that raises an error instead of stripping output when the limit is exceeded.
Tech stack
python
Domain
developer experience
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75