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.