AnswerDotAI / AnswerDotAI/nbdev

Render docs for methods by default

未关闭
#293 3 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看
enhancement
主要语言
Jupyter Notebook
星标
5.3k
派生
514
平均合并
2 天 30 分钟
30 天内合并 PR
8

描述

We should render docs for methods by default rather than requiring showdoc(...) on each method. Of course its better if people use showdoc(method) as that promotes better docs, but perhaps for people starting out it can help with initial setup?

贡献指南

打开贡献指南

调研方向

未指定文件、测试或入口点。首先定位 showdoc(method) 的实现和测试,然后比较默认渲染与显式的 showdoc(...)。完成的标准是:方法文档无需 showdoc(...) 即可渲染,同时现有的显式用法仍受支持。

由索引模型根据 Issue 内容生成。

评估

技术栈
jupyter-notebook, python
领域
documentation
Issue 类型
功能
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
30/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。