JuliaDocs/Documenter.jl

Doctests not catching exceptions from show

Open

#1 631 ouverte le 6 juil. 2021

Voir sur GitHub
 (0 commentaires) (0 réactions) (0 assignés)Julia (513 forks)batch import
Topic: UsabilityType: Bughelp wanted

Métriques du dépôt

Stars
 (910 stars)
Métriques de merge PR
 (Merge moyen 16j 9h) (3 PRs mergées en 30 j)

Description

This type of doctest, where show throws an error, does not work currently:

julia> gd
Error showing value of type GroupedDataFrame{DataFrame}:
ERROR: AssertionError: The current number of rows in the parent data frame is 3 and it does not match the number of rows it contained when GroupedDataFrame was created which was 2. The number of rows in the parent data frame has likely been changed unintentionally (e.g. using subset!, filter!, delete!, push!, or append! functions).

I believe it's because Documenter does not handle exceptions from the show calls which happen here: https://github.com/JuliaDocs/Documenter.jl/blob/6c8679bac445ab1c656744075b13a57835081cc3/src/DocTests.jl#L319

X-ref https://github.com/JuliaData/DataFrames.jl/pull/2811

Guide contributeur

Direction de recherche
Examinez l'appel show dans DocTests.jl autour de la ligne 319 pour comprendre pourquoi les exceptions de show ne sont pas interceptées. Ajoutez ensuite une gestion d'erreur appropriée pour intercepter et signaler ces exceptions dans les doctests.
Stack technique
julia
Domaine
documentationtesting
Type d'issue
Bug
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
3
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.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitJulia
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
70