facebookresearch/fmmax

Documentation

Ouverte

#35 ouverte le 30 août 2023

Voir sur GitHubGuide contributeur
 (0 commentaire) (1 réaction) (0 personne assignée)Jupyter Notebook (15 forks)auto 404
documentationenhancementgood first issue

Métriques du dépôt

Stars
 (149 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

Would be good to export the API docstrings into some documentation. The examples could be exported too (even better would be to export notebooks with the accompanying text explaining things).

Guide contributeur

Direction de recherche
Utilisez un générateur de documentation comme Sphinx pour générer automatiquement la documentation API à partir des docstrings et incluez des notebooks Jupyter comme exemples. Assurez vous que la sortie soit conviviale et couvre les fonctionnalités clés.
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.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Récente
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Aucun
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80