facebookresearch/hydra

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

Offen

#845 geöffnet am 05.08.2020

Auf GitHub ansehenContributor Guide
 (4 Kommentare) (2 Reaktionen) (0 zugewiesene Personen)Python (608 Forks)batch import
documentationgood first issuetriage

Repository-Metriken

Stars
 (7.539 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 37T 6h) (25 gemergte PRs in 30 T)

Beschreibung

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-Richtung
Machen Sie sich mit der Dokumentationsstruktur von Hydra vertraut und erstellen Sie eine neue eigenständige Seite, die das Verhalten des Rückgabewerts, die Unterstützung der Konfigurationsweitergabe und die detaillierte Parameterdokumentation für @hydra.main() abdeckt. Sehen Sie sich vorhandene Dokumentationsseiten für Stil und Format an.
Tech Stack
python
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitPython
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
85