AlgebraicJulia/Catlab.jl

Clean up API docs for stable modules

Open

#48 ouverte le 28 sept. 2019

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Julia (68 forks)batch import
docsgood first issue

Métriques du dépôt

Stars
 (706 stars)
Métriques de merge PR
 (Aucune PR mergée 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
Commencez par examiner la documentation API actuelle pour les modules stables mentionnés dans l'issue. Suivez les conventions de docstring de Julia et les fonctionnalités de Documenter.jl comme @ref et @id. Consultez la documentation existante dans le dépôt pour des exemples. Il n'existe pas encore de PR ou de commentaires liés ; il s'agit d'une tâche ouverte prête pour un contributeur.
Stack technique
Aucun
Domaine
documentationapi
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.
Ancienne
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
JuliaDocumenter.jlMarkdown
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75