nteract/papermill

Improve documentation on execute_notebook

Open

Aperta il 16 ott 2024

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Python (5381 star) (402 fork)batch import
docsenhancementhelp wanted

Descrizione

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.

Guida contributor

Tech stack
python
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
fresh
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Basic Python knowledgeFamiliarity with Jupyter notebooksUnderstanding of CLI parameters
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
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.