JuliaLang/julia

Include all public docstrings in the manual

Open

#19 529 ouverte le 7 déc. 2016

Voir sur GitHub
 (8 commentaires) (2 réactions) (0 assignés)Julia (5 773 forks)batch import
docsdocsystemhelp wanted

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

Currently there are a significant number (200+) docstrings in Base and it's submodules that are not included in the manual anywhere. To see the current list of docstrings that still need to be included change the following line in doc/make.jl

    checkdocs = :none,

to

    checkdocs = :all,

and build the docs with

make docs

from the root directory.

There's some docstrings for names that are exported and should definitely find there way into the manual somewhere, as well as quite a few internal docstrings that probably don't need to be included or could do with some improvements before inclusion.

(I'm marking this issue as up-for-grabs since it can readily be distributed between many contributors.)

Guide contributeur

Direction de recherche
Commencez par modifier le fichier `doc/make.jl` pour définir `checkdocs = :all` au lieu de `:none`, puis construisez la documentation en utilisant `make docs` depuis le répertoire racine. Cela générera une liste de toutes les docstrings actuellement non incluses dans le manuel. Pour chaque docstring, déterminez si elle est exportée (publique) et doit être ajoutée à la page appropriée du manuel. Pour les docstrings internes, évaluez si elles nécessitent une révision ou peuvent être omises. L'issue est marquée comme up for grabs, donc les contributeurs peuvent se concentrer sur un sous ensemble de docstrings. Consultez les commentaires existants pour obtenir des conseils sur les docstrings à prioriser.
Stack technique
Aucun
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.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitJulia basics
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75