AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Ouverte

#48 ouverte le 28 sept. 2019

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)Julia (68 forks)batch import
docsgood first issue

Métriques du dépôt

Stars
 (706 étoiles)
Métriques de merge PR
 (Merge moyen 17j 19h) (2 PRs mergées en 30 j)

Description

Certain modules, such as for wiring diagrams, are approaching a reasonable degree of API stability. It would be good to improve the API docs. This means following the Julia docstring conventions and using Documenter.jl features such as @ref and @id, which I have not been consistently doing.

Guide contributeur

Direction de recherche
Étudiez les docstrings existants dans le module de schémas de câblage et mettez les à jour pour suivre les conventions de docstring de Julia et les fonctionnalités de Documenter.jl comme @ref et @id.
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
JuliaGit
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75