facebookresearch/hydra

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

Open

#845 opened on Aug 5, 2020

View on GitHub
 (4 comments) (2 reactions) (0 assignees)Python (7,539 stars) (608 forks)batch import
documentationgood first issue

Description

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

Contributor guide

Tech stack
python
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
PythonHydra basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
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