JuliaLang/julia

Better documentation of stdlibs

Open

#28 712 ouverte le 16 août 2018

Voir sur GitHub
 (20 commentaires) (4 réactions) (0 assignés)Julia (5 773 forks)batch import
docsgood first issue

Métriques du dépôt

Stars
 (48 709 stars)
Métriques de merge PR
 (Merge moyen 20j 6h) (157 PRs mergées en 30 j)

Description

A lot of functionality has been moved from Base to stdlibs. However, for people who haven't been part of this process (especially beginners) it is not really transparent which stdlibs exist and what their purpose is.

The documentation doesn't seem to contain a list of all stdlibs with short descriptions. I think such a list would be very useful as a compact overview of all stdlibs.

The only kind of overview is the navigation pane. There, however, names do not match actual stdlib names and short descriptions are missing.

  1. Do people agree that such a list would be good to have?
  2. Where should such a table go?

Guide contributeur

Direction de recherche
Identifiez toutes les bibliothèques standard déplacées de Base vers stdlibs et compilez une liste avec descriptions. Vérifiez la documentation existante pour toute liste cachée et proposez un emplacement pour le nouveau tableau.
Stack technique
julia
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.
Active
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