nteract/papermill

Improve documentation on execute_notebook

Open

#808 aberto em 16 de out. de 2024

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Python (402 forks)batch import
docsenhancementhelp wanted

Métricas do repositório

Stars
 (5.381 stars)
Métricas de merge de PR
 (Nenhuma PRs mesclada em 30d)

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.

Guia do colaborador

Direção de pesquisa
Investigue a função execute notebook em papermill/execute.py e documente todos os parâmetros opcionais. Compare com os parâmetros CLI de papermill/cli.py. Adicione uma nova página na documentação ou atualize a documentação existente, seguindo o estilo de documentação existente. O problema menciona que os parâmetros são semelhantes aos da CLI, portanto, consulte a documentação da CLI para orientação.
Pilha de tecnologia
python
Domain
tooling
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Recente
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitPython
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
80