Skip to content

Fixes for docs and show methods#51

Open
cgarling wants to merge 6 commits intogetzze:mainfrom
cgarling:edit-1
Open

Fixes for docs and show methods#51
cgarling wants to merge 6 commits intogetzze:mainfrom
cgarling:edit-1

Conversation

@cgarling
Copy link

I was checking this package out (very cool!) and found a few issues with the documentation that this fixes. Some are minor typo fixes, two larger changes are described below

  • The doctest in docs/src/examples.md that show the RobustLinearModel were failing because the CoefsTable part was not displaying correctly. I fixed this for both RobustLinearModel and QuantileRegression types.
  • The doctests that get run for StatsBase were erroring because they were not finding methods exported from StatsBase. I fixed this by adding doctestsetup steps for the other packages included in modules for Documenter.make.

The docs now successfully build for me locally (Julia v1.12), my docs environment looks like

Status ~/Development/julia/RobustModels.jl/docs/Project.toml
[324d7699] CategoricalArrays v1.1.0
[a93c6f00] DataFrames v1.8.1
[31c24e10] Distributions v0.25.123
[e30172f5] Documenter v1.17.0
[38e38edf] GLM v1.9.3
[ce6b1742] RDatasets v0.8.1
[d6ea1423] RobustModels v0.6.0 ..
[10745b16] Statistics v1.11.1
[82ae8749] StatsAPI v1.8.0
[2913bbd2] StatsBase v0.34.10
[3eaba693] StatsModels v0.7.9
[37e2e46d] LinearAlgebra v1.12.0
[2f01184e] SparseArrays v1.12.0

docs/example.md expects the "pretty table" representation for the coefficient table, this updates the show methods use the more specific `show` method for the `CoefTable` type.
When running doctests on GLM, StatsBase, StatsAPI we need to make sure their doctestsetup is correct
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant