nteract/papermill

Improve documentation on execute_notebook

Open

#808 geöffnet am 16. Okt. 2024

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Python (402 Forks)batch import
docsenhancementhelp wanted

Repository-Metriken

Stars
 (5.381 Stars)
PR-Merge-Metriken
 (Keine gemergten PRs in 30 T)

Beschreibung

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

Research-Richtung
Untersuche die Funktion execute notebook in papermill/execute.py und dokumentiere alle optionalen Parameter. Vergleiche sie mit den CLI Parametern aus papermill/cli.py. Füge eine neue Seite in der Dokumentation hinzu oder aktualisiere die vorhandene Dokumentation, wobei du dem vorhandenen Dokumentationsstil folgst. Das Problem erwähnt, dass die Parameter ähnlich wie die CLI Parameter sind, daher beziehe dich für Anleitungen auf die CLI Dokumentation.
Tech Stack
python
Domain
tooling
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Frisch
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
80