search

JuliaStats / HypothesisTests.jl

Hypothesis tests for Julia
MIT License
295 stars 87 forks source link

CompatHelper: bump compat for Documenter to 1 for package docs, (keep existing compat) #309

Closed github-actions[bot] closed 4 months ago

github-actions[bot] commented 1 year ago

This pull request changes the compat entry for the Documenter package from 0.27 to 0.27, 1 for package docs. This keeps the compat entries for earlier versions.

Note: I have not tested your package with this new compat entry. It is your responsibility to make sure that your package tests pass before you merge this pull request.

codecov-commenter commented 1 year ago

Codecov Report

Patch has no changes to coverable lines.

Files Changed Coverage
src/anderson_darling.jl ø
src/durbin_watson.jl ø

:loudspeaker: Thoughts on this report? Let us know!.

nalimilan commented 1 year ago

Failure was due to docstrings that are not included in the manual. Except for testname, which I added to the manual, the others are internal so I've turned them into comments, that seems better than disabling the check.

nalimilan commented 1 year ago

Actually I hadn't realized we could pass checkdocs=:exports to avoid throwing errors if docstrings for non exported functions are not included in the manual. Probably better do that instead of turning internal docstrings into plain comments?

bkamins commented 1 year ago

Yes - I would keep docstrings and just disable tests. The alternative approach is used in DataFrames.jl with hide, see https://github.com/JuliaData/DataFrames.jl/blob/main/docs/make.jl#L42