Flux.jl icon indicating copy to clipboard operation
Flux.jl copied to clipboard

Fix the last remaining 404 errors

Open Saransh-cpp opened this issue 3 years ago • 3 comments

The only thing keeping me from making the cross reference check strict -

strict = [:cross_references]

is the failing isnumeric hyperlink (https://fluxml.ai/Flux.jl/stable/training/optimisers/#Optimisers.destructure), which does not have a docstring in Optimisers.jl.

PR Checklist

  • [ ] Tests are added
  • [ ] Entry in NEWS.md
  • [ ] Documentation, if applicable

Saransh-cpp avatar Aug 08 '22 09:08 Saransh-cpp

Nice! @mcabbott should we slap a docstring onto isnumeric or scrub the dangling reference to it in https://github.com/FluxML/Optimisers.jl/blob/9b75dbb0d80e4e383eab279345a70d4b567721ea/src/destructure.jl#L8?

ToucheSir avatar Aug 08 '22 23:08 ToucheSir

Could go either way. I made https://github.com/FluxML/Optimisers.jl/pull/104 to see how it looks.

mcabbott avatar Aug 09 '22 00:08 mcabbott

I will fix the reference here once https://github.com/FluxML/Optimisers.jl/pull/104 is merged!

Saransh-cpp avatar Aug 09 '22 09:08 Saransh-cpp

Temporarily fixed the references for the API of OneHotArrays.jl. See #2038.

Saransh-cpp avatar Aug 11 '22 18:08 Saransh-cpp

If you wouldn't mind looking into the doctest failure, we can get this merged.

ToucheSir avatar Aug 12 '22 01:08 ToucheSir

  • The regex pattern is getting out of hand 😅 but now it captures Float32 values too (which were causing the CI to fail).
  • Documenter.jl was outdated and was not allowing strict to be of the type Vector{Symbol}.

I think a new release for Optimisers.jl is required for the tests to pass. The CI is still not picking up the docstring for Optimisers.isnumeric.

(Test out the regex here - https://regex101.com/r/THfO8E/1)

Saransh-cpp avatar Aug 12 '22 11:08 Saransh-cpp

I think a new release for Optimisers.jl is required for the tests to pass. The CI is still not picking up the docstring for Optimisers.isnumeric.

Ok, I was wondering why it worked given that wasn't tagged! Have another try after https://github.com/JuliaRegistries/General/pull/66169.

ToucheSir avatar Aug 13 '22 00:08 ToucheSir

Have another try after https://github.com/JuliaRegistries/General/pull/66169.

Everything works now!

Saransh-cpp avatar Aug 13 '22 07:08 Saransh-cpp