Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Merge in tutorial changes from snap

Clarify the behavior of snaplet filesystem installation in the tutorial
  • Loading branch information...
commit 07d7cff770f91e763af431be1673c2fc573a2031 1 parent 76b1240
@mightybyte mightybyte authored
Showing with 10 additions and 4 deletions.
  1. +10 −4 snaplets/heist/templates/docs/tutorials/snaplets-tutorial.lhs
View
14 snaplets/heist/templates/docs/tutorials/snaplets-tutorial.lhs
@@ -271,9 +271,9 @@ This completes a full working application. We did leave out a little dummy
code for the Foo and Bar snaplets. This code is included in Part2.hs. For
more information look in our [API
documentation](http://hackage.haskell.org/package/snap), specifically the
-Snap.Snaplet module. No really, that wasn't a joke. The API docs are
-written as prose. It is written to be very easy to read, while having the
-benefit of including all the actual type signatures.
+Snap.Snaplet module. No really, that wasn't a joke. The API docs are written
+as prose. They should be very easy to read, while having the benefit of
+including all the actual type signatures.
Filesystem Data and Automatic Installation
==========================================
@@ -352,5 +352,11 @@ including a section like the following in snaplet-killerapp.cabal:
Now whenever your snaplet is used, its filesystem data will be automagically
copied into the local project that is using it, whenever the application is
-run and it sees that the files don't already exist.
+run and it sees that the snaplet's directory does not already exist. If the
+user upgrades to a new version of the snaplet and the new version made changes
+to the filesystem resources, those resources will NOT be automatically copied
+in by default. Resource installation *only* happens when the `snaplets/foo`
+directory does not exist. If you want to get the latest version of the
+filesystem resources, remove the `snaplets/foo` directory, and restart your
+app.
Please sign in to comment.
Something went wrong with that request. Please try again.