search

astro-group-bristol / Gradus.jl

Extensible spacetime agnostic general relativistic ray-tracing (GRRT).
https://astro-group-bristol.github.io/Gradus.jl/dev/
GNU General Public License v3.0
18 stars 2 forks source link

Update documentation #76

Closed fjebaker closed 1 year ago

fjebaker commented 1 year ago

Self descriptive

phajy commented 1 year ago

The Covariant radiative transfer example isn't working. The documentation is likely lagging behind the code but I couldn't figure it out myself at a quick look - will continue looking.

The code in the documentation produces the following

ERROR: TypeError: in keyword argument μ, expected Float64, got a value of type Int64
fjebaker commented 1 year ago

@phajy yes I am aware of this bug, it was broken in

The code that fixes it is in master, via

but the version has not been bumped since, which is why the registry version is still out of date.

I will open an issue about adding the examples to a seperate test-suite though, so that these breaking changes are caught earlier. They were removed to reduce the test runner time, but this isn't the first time an example has broken since that was done, so they should really be added back.