TuringLang / Bijectors.jl

Implementation of normalising flows and constrained random variable transformations
https://turinglang.org/Bijectors.jl/
MIT License
200 stars 33 forks source link

Fixed double double subscripts in Docs #185

Closed storopoli closed 3 years ago

storopoli commented 3 years ago

This is not rendering right in Turing.ml Documentation. See here (https://turing.ml/dev/docs/library/bijectors/#Bijectors.compute_r-Tuple{AbstractVector{var%22#s111%22}%20where%20var%22#s111%22%3C:Real,%20Any,%20Any}). I've tried to corrected it but I don't know if the intent is to signal that α is positive constrained (and y is negative constrained). I would do something like $\alpha^{+}$ (or $y^{-}$).

Screen Shot 2021-06-13 at 10 27 11
storopoli commented 3 years ago

Ah! Know I get it. The problem is that the bijectors.md for the documentation is kinda hard coded into the jekyll markdown. See here: https://github.com/TuringLang/Turing.jl/blob/master/docs/src/library/bijectors.md

devmotion commented 3 years ago

IMO it should be removed completely and be replaced with a proper documentation in Bijectors.

storopoli commented 3 years ago

I agree. Thanks for the input.