nteract/papermill

Improve documentation on execute_notebook

Open

#808 创建于 2024年10月16日

在 GitHub 查看
 (0 评论) (0 反应) (0 负责人)Python (5,381 star) (402 fork)batch import
docsenhancementhelp wanted

描述

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.

贡献者指南

技术栈
python
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
Basic Python knowledgeFamiliarity with Jupyter notebooksUnderstanding of CLI parameters
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
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.