facebookresearch/hydra

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

Open

#845 ouverte le 5 août 2020

Voir sur GitHub
 (4 commentaires) (2 réactions) (0 assignés)Python (608 forks)batch import
documentationgood first issue

Métriques du dépôt

Stars
 (7 539 stars)
Métriques de merge PR
 (Merge moyen 37j 6h) (25 PRs mergées en 30 j)

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

Guide contributeur

Direction de recherche
Familiarisez vous avec la structure de documentation d'Hydra, puis créez une nouvelle page autonome couvrant le comportement de la valeur de retour, le support du passage de configuration et la documentation détaillée des paramètres de @hydra.main(). Regardez les pages de documentation existantes pour le style et le format.
Stack technique
python
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitPython
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
85