JuliaDocs/Documenter.jl

Doctests not catching exceptions from show

Open

#1.631 aberto em 6 de jul. de 2021

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)Julia (513 forks)batch import
Topic: UsabilityType: Bughelp wanted

Métricas do repositório

Stars
 (910 stars)
Métricas de merge de PR
 (Mesclagem média 16d 9h) (3 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Examine a chamada show em DocTests.jl por volta da linha 319 para entender por que as exceções de show não são capturadas. Em seguida, adicione o tratamento adequado de erros para capturar e relatar tais exceções nos doctests.
Pilha de tecnologia
julia
Domain
documentationtesting
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
3
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Meio dia
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitJulia
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
70