JuliaLang / AllocCheck.jl

AllocCheck
Other
215 stars 8 forks source link

Add tutorials #15

Closed baggepinnen closed 9 months ago

baggepinnen commented 10 months ago

This PR adds tutorials corresponding roughly to the topics discussed in #1


Depended on

baggepinnen commented 10 months ago

I can't quite figure out why a test I added to one of the documentation examples is failing on CI:

┌ Error: failed to run `@example` block in src/tutorials/error_recovery.md:54-58
│ ```@example ERROR
│ treading_lightly() # Warm start
│ allocated_memory = @allocated treading_lightly() # A call that triggers the exception path
│ @test allocated_memory < 1e4
│ ```
│   exception = There was an error during testing

When I run the code locally, I get

julia> allocated_memory
288
topolarity commented 9 months ago

I can't quite figure out why a test I added to one of the documentation examples is failing on CI:

Also fails for me locally if I run julia ./docs/make.jl

Not sure what the root problem is, so for now I've commented out the @test. Documenter has its own Eval loop that it uses to evaluate code, which might be contributing to this.