Update REPL script documentation #3920
Conversation
akshaysridhar
force-pushed
the
as/demo-ex
branch
3 times, most recently
from
fc8d1b2 to
5f0964a
Compare
|
We can run this example as part of the Literate.jl / Documenter |
akshaysridhar
force-pushed
the
as/demo-ex
branch
2 times, most recently
from
0179f24 to
f971a53
Compare
.buildkite/Manifest-v1.11.toml
Outdated
There was a problem hiding this comment.
Could we revert the change in this file?
docs/src/repl_scripts.md
Outdated
| ``` | ||
|
|
||
| ```julia | ||
| julia> using Revise # See also: Infiltrator.jl and Main.@infiltrate |
There was a problem hiding this comment.
I don't think Revise is a dependency of ClimaAtmos - how could this work as a test?
There was a problem hiding this comment.
Switching to use Literate.jl should allow lines with # to be treated as comments and run all other lines as standard julia code, so we can still exercise the AtmosConfig, AtmosSimulation, atmos_solve!(simulation) and step!(simulation.integrator) methods - Revise is still an external reference as a doc example.
There was a problem hiding this comment.
So is this being tested now? I'm fine with merging it either way, but I don't think it is tested.
There was a problem hiding this comment.
I think we would see an error in the doc build? Would that be good enough warning?
There was a problem hiding this comment.
Instructions within the example block are being run and should show corresponding output (there is an issue here in that I can get this to work locally but it fails at some albedo plot generation unrelated to this PR in the github actions job, prior to even reaching the REPL docs - I'll look into this shortly)
There was a problem hiding this comment.
Oh I think we are testing it in the latest commit now - and now it is failing 😂
akshaysridhar
force-pushed
the
as/demo-ex
branch
5 times, most recently
from
ab333f6 to
65355fc
Compare
akshaysridhar
force-pushed
the
as/demo-ex
branch
3 times, most recently
from
2f6196b to
d4917b4
Compare
Simplified version of
.buildkite/ci_driver.jlthat shows one example of a debugging workflow usingRevise.