add comment explaining Revise usage (#155)

Co-authored-by: BrianGun <[email protected]>
microsoft · Apr 28, 2021 · e14c997 · e14c997
1 parent 2d3690a
commit e14c997
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/src/OpticSim.jl b/src/OpticSim.jl
@@ -12,6 +12,9 @@ using Images
 using Base: @.
 using ForwardDiff
 using StringEncodings
+
+# this dependency is intentional! Revise allows OpticSim to reload AGFGlassCat.jl (the glass database) after calling
+# `add_agf` (src/GlassCat/sources.jl) with `rebuild = true`
 using Revise
 
 # included here to allow a call to the activate! during the initialization