@@ -31,8 +31,6 @@ import qualified System.Log.FastLogger as FLogger
3131--
3232-- It makes a few __important assumptions__ about your 'jobPayload 'JSON, which
3333-- are documented in 'defaultJobType'.
34−--
35−-- TODO: Link-off to tutorial.
3634mkConfig :: (LogLevel -> LogEvent -> IO ())
3735 -- ^ "Structured logging" function. Ref: 'cfgLogger'
3836 -> TableName
@@ -216,6 +214,11 @@ defaultDynamicJobTypes tname jobTypeSql = AJTSql $ \conn -> do
216214--
217215-- Even if tihs assumption is violated, the job-runner /should/ continue to
218216-- function. It's just that you won't get very useful log messages.
217+--
218+-- __Note:__ If your job payload does not conform to the structure described
219+-- above, please read the section on [customising the job payload's
220+-- structure](https://www.haskelltutorials.com/odd-jobs/guide.html#custom-payload-structure)
221+-- in the implementation guide.
219222defaultJobType :: Job -> Text
220223defaultJobType Job{jobPayload} =
221224 case jobPayload of
@@ -231,7 +234,7 @@ defaultPollingInterval = Seconds 5
231234
232235-- | Convenience function to create a DB connection-pool with some sensible
233236-- defaults. Please see the source-code of this function to understand what it's
234−-- doing. TODO: link-off to tutorial.
237+-- doing.
235238withConnectionPool :: (MonadUnliftIO m)
236239 => Either BS.ByteString PGS.ConnectInfo
237240 -> (Pool PGS.Connection -> m a)