facebookresearch/hydra

Add a standalone page describing @hydra.main() in details.

Open

#845 创建于 2020年8月5日

在 GitHub 查看
 (4 评论) (2 反应) (0 负责人)Python (7,539 star) (608 fork)batch import
documentationgood first issue

描述

Input from @omry : There are many details that does not fit into the tutorial.

  • the behavior of the return value.
  • support for config passthrough
  • detailed documentation of the parameters

贡献者指南

技术栈
python
领域
documentationdeveloper experience
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
PythonHydra basics
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
Examine the existing Hydra documentation in the repository, likely under docs/ directory. Identify the appropriate location for a standalone page about @hydra.main(). Review the decorator's source code in hydra/main.py and any related configuration handling to document parameters and return behavior. Check the issue comments and linked discussions for additional details. Create a new documentation page following the existing format and add it to the documentation index.