JuliaDocs/Documenter.jl

Doctests not catching exceptions from show

Open

#1631 aperta il 6 lug 2021

Vedi su GitHub
 (0 commenti) (0 reazioni) (0 assegnatari)Julia (513 fork)batch import
Topic: UsabilityType: Bughelp wanted

Metriche repository

Star
 (910 star)
Metriche merge PR
 (Merge medio 16g 9h) (3 PR mergiate in 30 g)

Descrizione

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

Guida contributor

Direzione di ricerca
Esamina la chiamata a show in DocTests.jl intorno alla riga 319 per capire perché le eccezioni da show non vengono catturate. Aggiungi quindi una gestione degli errori appropriata per catturare e segnalare tali eccezioni nei doctest.
Tech stack
julia
Dominio
documentationtesting
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
GitJulia
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70