nteract/papermill

Improve documentation on execute_notebook

Open

#808 opened on Oct 16, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (5,381 stars) (402 forks)batch import
docsenhancementhelp wanted

Description

Add parameters to execute_notebook

We should add a page that showcase all optional parameters that you can add to the execute_notebook method, I think this are similar to the CLI ones

Motivation

Given this is not a method heavy library I understand we don't have a page documenting which parameters each function has (I don't know if the API even has something else than execute_notebook) however it wasn't clear how to use log-output or other parameters until I found the internal workings of the bin.

Contributor guide

Tech stack
python
Domain
documentation
Issue type
documentation
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.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic Python knowledgeFamiliarity with Jupyter notebooksUnderstanding of CLI parameters
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Investigate the execute notebook function in papermill/execute.py and document all optional parameters. Compare with CLI parameters from papermill/cli.py. Add a new page in the docs or update existing documentation, following the existing documentation style. The issue mentions that parameters are similar to CLI ones, so refer to the CLI documentation for guidance.