facebookresearch/fmmax

Documentation

开放

#35 创建于 2023年8月30日

在 GitHub 查看贡献者指南
 (0 条评论) (1 个反应) (0 位负责人)Jupyter Notebook (15 个派生)auto 404
documentationenhancementgood first issue

仓库指标

星标
 (149 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Would be good to export the API docstrings into some documentation. The examples could be exported too (even better would be to export notebooks with the accompanying text explaining things).

贡献者指南

研究方向
使用像Sphinx这样的文档生成器从文档字符串自动生成API文档，并包含Jupyter笔记本作为示例。确保输出用户友好且涵盖关键功能。
技术栈
python
领域
documentation
议题类型
文档
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 小时
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
新近可参与
清晰度议题是否清楚说明期望改动、验收标准和下一步。
清晰
前置要求
无
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80