facebookresearch/hydra

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

Open

#845 opened on Aug 5, 2020

View on GitHubContributor guide
 (4 comments) (2 reactions) (0 assignees)Python (608 forks)batch import
documentationgood first issuetriage

Repository metrics

Stars
 (7,539 stars)
PR merge metrics
 (Avg merge 37d 6h) (25 merged PRs in 30d)

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

Research direction
Familiarize yourself with Hydra's documentation structure, then create a new standalone page covering the return value behavior, config passthrough support, and detailed parameter documentation for @hydra.main(). Look at existing documentation pages for style and format.
Tech stack
python
Domain
documentation
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPython
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85