facebookresearch/hydra

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

Open

#845 opened on 2020年8月5日

GitHub で見る
 (4 comments) (2 reactions) (0 assignees)Python (7,539 stars) (608 forks)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
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
2
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
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.
Add a standalone page describing @hydra.main() in details. · facebookresearch/hydra#845 | Good First Issue