nteract/papermill

Improve documentation on execute_notebook

Open

#808 ouverte le 16 oct. 2024

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Python (402 forks)batch import
docsenhancementhelp wanted

Métriques du dépôt

Stars
 (5 381 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

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.

Guide contributeur

Direction de recherche
Étudiez la fonction execute notebook dans papermill/execute.py et documentez tous les paramètres optionnels. Comparez avec les paramètres CLI de papermill/cli.py. Ajoutez une nouvelle page dans la documentation ou mettez à jour la documentation existante, en suivant le style de documentation existant. Le problème mentionne que les paramètres sont similaires à ceux de la CLI, donc référez vous à la documentation CLI pour obtenir des conseils.
Stack technique
python
Domaine
tooling
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80