[FR] Make it easier to show source in docs for thin classes
还没有人认领这个 Issue。
评估
- 难度
- 4/5
- 预计耗时
- 3-5 天
- 新手友好度
- 35/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 停滞
- 技术栈
- jupyter, python
调研方向
从 nbdev 的 show_doc 入口点开始，重现 Colors 示例，以检查当前如何渲染一个精简类。跟踪文档渲染路径，然后验证带有 full_source=True 的选择启用形式会显示完整的类源代码，同时现有的 show_doc(Colors) 行为保持不变。
由索引模型根据 Issue 内容生成。
描述
Minimally reproducible example:
from enum import Enum # StrEnum for python >= 3.12
from nbdev import show_doc
class Colors(str, Enum): # Or `StrEnum` if on python >= 3.12
"Enum with the valid colors we can use in our package"
RED = "red"
GREEN = "green"
BLUE = "blue"
show_doc(Colors)
Issue description
This it not really a bug, more like a feature request. When defining thin classes, such as enums or dataclasses, the documentation for those classes shows a very uninformative ClassName (*values).
For this use case, it would be really useful to have an option that would allow inlining the entire class source in the docs, to get a view of all the possible values. To avoid breaking existing code this could be implemented as an optional argument to the show_doc method, so to enable this one would do something like show_doc(Colors, full_source=True)
- 主要语言
- Jupyter Notebook
- 星标
- 5.3k
- 派生
- 517
- 平均合并
- 1 天 3 小时
- 30 天内合并 PR
- 2
环境准备
- 没有 Dockerfile 或 Docker Compose 文件
- 没有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue，再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 Issue 编号。
AnswerDotAI/nbdev 的其他 Issue
-
Bug Report: `nbdev` Parser `IndexError` on `@patch_to` with Keyword Arguments可能已有人在做 @ruchi-mish90 于 88 天前认领。 未关闭bug
难度 2/5 1-3 小时 新手友好度 78/100
AnswerDotAI/nbdev#1596 · 1 条评论 ·
-
难度 5/5 一周以上 新手友好度 25/100
AnswerDotAI/nbdev#1587 ·
-
Interested in Windows support?可能已有人在做 @mrexodia 于 12 天前认领。 未关闭
难度 4/5 3-5 天 新手友好度 35/100
AnswerDotAI/nbdev#1584 · 1 条评论 ·
-
难度 3/5 1-2 天 新手友好度 35/100
AnswerDotAI/nbdev#1583 · 1 条评论 · 1 个 reaction ·
-
bug
难度 3/5 1-2 天 新手友好度 52/100
AnswerDotAI/nbdev#1581 ·
查看 AnswerDotAI/nbdev 的全部 Issue
相似的 Issue
-
area: docs difficulty: easy documentation good first issue
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 69/100
manuscript-lang/manuscript#198 · 1 条评论 ·
维护者通常 1 天内回复
-
bug needs-acceptance
难度 2/5 1-3 小时 新手友好度 65/100
vllm-project/semantic-router#5002 · 1 条评论 ·
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 90/100
维护者通常 1 天内回复
-
.NET Azure Functions Docs OpenTelemetry
难度 2/5 1-3 小时 新手友好度 82/100
getsentry/sentry-dotnet#5715 · 1 条评论 ·
维护者通常 2 天内回复