Skip to content

Commit

Permalink
Don't load PosteriorStats in doctests (#11)
Browse files Browse the repository at this point in the history
* Don't load PosteriorStats in docstrings

* Increment patch number
  • Loading branch information
sethaxen authored Aug 8, 2023
1 parent 8a2fc98 commit 6d0f1cc
Show file tree
Hide file tree
Showing 9 changed files with 8 additions and 10 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "PosteriorStats"
uuid = "7f36be82-ad55-44ba-a5c0-b8b5480d7aa5"
authors = ["Seth Axen <[email protected]> and contributors"]
version = "0.1.1"
version = "0.1.2"

[deps]
Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
Expand Down
2 changes: 1 addition & 1 deletion src/compare.jl
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Compare the centered and non centered models of the eight school problem using t
as expected by [`loo`](@ref).
```jldoctest compare; filter = [r"└.*"]
julia> using ArviZExampleData, PosteriorStats
julia> using ArviZExampleData
julia> models = (
centered=load_example_data("centered_eight"),
Expand Down
2 changes: 0 additions & 2 deletions src/hdi.jl
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,6 @@ This implementation uses the algorithm of [^ChenShao1999].
Here we calculate the 83% HDI for a normal random variable:
```jldoctest hdi; setup = :(using Random; Random.seed!(78))
julia> using PosteriorStats
julia> x = randn(2_000);
julia> hdi(x; prob=0.83) |> pairs
Expand Down
2 changes: 1 addition & 1 deletion src/loo.jl
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ See also: [`PSISLOOResult`](@ref), [`waic`](@ref)
Manually compute ``R_\\mathrm{eff}`` and calculate PSIS-LOO of a model:
```jldoctest
julia> using ArviZExampleData, MCMCDiagnosticTools, PosteriorStats
julia> using ArviZExampleData, MCMCDiagnosticTools
julia> idata = load_example_data("centered_eight");
Expand Down
2 changes: 1 addition & 1 deletion src/loo_pit.jl
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ LOO-PIT values should be approximately uniformly distributed on ``[0, 1]``.[^Gab
Calculate LOO-PIT values using as test quantity the observed values themselves.
```jldoctest loo_pit1
julia> using ArviZExampleData, PosteriorStats
julia> using ArviZExampleData
julia> idata = load_example_data("centered_eight");
Expand Down
2 changes: 1 addition & 1 deletion src/model_weights.jl
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ See also: [`AbstractModelWeightsMethod`](@ref), [`compare`](@ref)
Compute [`Stacking`](@ref) weights for two models:
```jldoctest model_weights; filter = [r"└.*"]
julia> using ArviZExampleData, PosteriorStats
julia> using ArviZExampleData
julia> models = (
centered=load_example_data("centered_eight"),
Expand Down
2 changes: 1 addition & 1 deletion src/r2_score.jl
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# Examples
```jldoctest
julia> using ArviZExampleData, PosteriorStats
julia> using ArviZExampleData
julia> idata = load_example_data("regression1d");
Expand Down
2 changes: 1 addition & 1 deletion src/summarize.jl
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ See also [`SummaryStats`](@ref), [`default_summary_stats`](@ref), [`default_stat
Compute `mean`, `std` and the Monte Carlo standard error (MCSE) of the mean estimate:
```jldoctest summarize; setup = (using Random; Random.seed!(84))
julia> using PosteriorStats, Statistics, StatsBase
julia> using Statistics, StatsBase
julia> x = randn(1000, 4, 3) .+ reshape(0:10:20, 1, 1, :);
Expand Down
2 changes: 1 addition & 1 deletion src/waic.jl
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ See also: [`WAICResult`](@ref), [`loo`](@ref)
Calculate WAIC of a model:
```jldoctest
julia> using ArviZExampleData, PosteriorStats
julia> using ArviZExampleData
julia> idata = load_example_data("centered_eight");
Expand Down

2 comments on commit 6d0f1cc

@sethaxen
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/89259

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.2 -m "<description of version>" 6d0f1cc1e99232014a41b111e115acc766253fa3
git push origin v0.1.2

Please sign in to comment.