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.