nteract/papermill

Improve documentation on execute_notebook

Open

#808 aperta il 16 ott 2024

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

Metriche repository

Star
 (5381 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

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

Direzione di ricerca
Analizza la funzione execute notebook in papermill/execute.py e documenta tutti i parametri opzionali. Confronta con i parametri CLI da papermill/cli.py. Aggiungi una nuova pagina nella documentazione o aggiorna la documentazione esistente, seguendo lo stile di documentazione esistente. Il problema menziona che i parametri sono simili a quelli CLI, quindi fai riferimento alla documentazione CLI per indicazioni.
Tech stack
python
Dominio
tooling
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitPython
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
80