From 3d11322d378250402d9ed755dc8b298b39d1f516 Mon Sep 17 00:00:00 2001
From: Dhairya Gandhi <dhairya@juliacopmuting.com>
Date: Wed, 22 Aug 2018 00:29:07 +0530
Subject: [PATCH] fixed docstring and not exporting stop

---
 src/Flux.jl           | 3 ++-
 src/optimise/train.jl | 4 ++--
 2 files changed, 4 insertions(+), 3 deletions(-)

diff --git a/src/Flux.jl b/src/Flux.jl
index 525b33c4..18195901 100644
--- a/src/Flux.jl
+++ b/src/Flux.jl
@@ -21,7 +21,8 @@ include("optimise/Optimise.jl")
 using .Optimise
 using .Optimise: @epochs
 export SGD, ADAM, ADAMW, AdaMax, Momentum, Nesterov,
-       RMSProp, ADAGrad, ADADelta, AMSGrad, NADAM, stop
+       RMSProp, ADAGrad, ADADelta, AMSGrad, NADAM
+
 
 include("utils.jl")
 include("onehot.jl")
diff --git a/src/optimise/train.jl b/src/optimise/train.jl
index 3ec3eb18..007613b6 100644
--- a/src/optimise/train.jl
+++ b/src/optimise/train.jl
@@ -18,7 +18,7 @@ struct StopException <: Exception end
 """
     stop()
 
-Call `stop()` in a callback to indicate when a callback condition is met.
+Call `Flux.stop()` in a callback to indicate when a callback condition is met.
 This would trigger the train loop to stop and exit.
 
 ```julia
@@ -89,4 +89,4 @@ macro epochs(n, ex)
       @info "Epoch $i"
       $(esc(ex))
     end)
-end
+end
\ No newline at end of file