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

Published 20 hours ago • verified publisher icon FluxML

mark `stop`, `skip`, `@epochs` as deprecated

Open mcabbott opened this issue 3 years ago • 5 comments

Replaces #1913 with the simpler plan to remove these from Flux 0.14.

mcabbott avatar Jul 27 '22 01:07 mcabbott

Should the occurrences of stop, skip, and @epochs be removed from the docs, or should this wait till they are removed (v0.14)? The doctests are failing due to the deprecation warnings. Should the doctests be removed, or should they be updated with the warnings?

Saransh-cpp avatar Jul 28 '22 14:07 Saransh-cpp

That's a good question. I think that:

  • For the dep-warns to be of any use, I guess this must be merged into a 0.13 release.
  • The removal of both the code and the docs should be in 0.14, thus a different PR
  • Possibly the last 0.13 docs should have a warning note added too? That could be this PR.
  • To keep tests passing, maybe this PR should also remove some jldoctest annotations.

mcabbott avatar Jul 28 '22 16:07 mcabbott

@Saransh-cpp maybe you know, are the built docs previewed somewhere? Is this !!! note thing going to work?

mcabbott avatar Jul 28 '22 21:07 mcabbott

@mcabbott the previews are only generated if a PR is created from a branch belonging to the root Flux repository (restrictions from Documenter.jl). If the PR is from a branch belonging to the root repository, adding the documentation tag to the PR will trigger the DocBot to comment the generated URL.

Saransh-cpp avatar Jul 29 '22 05:07 Saransh-cpp

!!! note works! Tested locally!

Saransh-cpp avatar Jul 29 '22 08:07 Saransh-cpp

Ready to merge?

mcabbott avatar Aug 27 '22 18:08 mcabbott