Add since annotations

Author: Shimuuar

src/Python/Inline/QQ.hs

@@ -97,6 +97,8 @@ pyf = QuasiQuoter
 --   'Python.Inline.Eval.exec'
 --
 --   It creates value of type @PyQuote@
+--
+--   @since 0.2@
 pycode :: QuasiQuoter
 pycode = QuasiQuoter
   { quoteExp  = \txt -> expQQ Exec txt

src/Python/Internal/Eval.hs

@@ -681,13 +681,17 @@ checkThrowBadPyType = do
 
 -- | Type class for values representing python dictionaries containing
 --   global or local variables.
+--
+--   @since 0.2@
 class Namespace a where
   -- | Returns dictionary object. Caller takes ownership of returned
   --   object.
   basicNamespaceDict :: a -> Py (Ptr PyObject)
 
 
 -- | Namespace for the top level code execution.
+--
+--   @since 0.2@
 data Main = Main
 
 instance Namespace Main where
@@ -703,6 +707,8 @@ instance Namespace Main where
 
 
 -- | Temporary namespace which get destroyed after execution
+--
+--   @since 0.2@
 data Temp = Temp
 
 instance Namespace Temp where
@@ -711,6 +717,8 @@ instance Namespace Temp where
 
 -- | Newtype wrapper for bare python object. It's assumed to be a
 --   dictionary. This is not checked.
+--
+--   @since 0.2@
 newtype DictPtr = DictPtr (Ptr PyObject)
 
 instance Namespace DictPtr where
@@ -719,6 +727,8 @@ instance Namespace DictPtr where
 
 -- | Newtype wrapper for bare python object. It's assumed to be a
 --   dictionary. This is not checked.
+--
+--   @since 0.2@
 newtype Dict = Dict PyObject
 
 instance Namespace Dict where
@@ -727,6 +737,8 @@ instance Namespace Dict where
     = unsafeWithPyObject d (basicNamespaceDict . DictPtr)
 
 -- | Newtype wrapper over module object.
+--
+--   @since 0.2@
 newtype ModulePtr = ModulePtr (Ptr PyObject)
 
 instance Namespace ModulePtr where
@@ -747,6 +759,8 @@ instance Namespace Module where
 
 
 -- | Evaluate python expression
+--
+--   @since 0.2@
 eval :: (Namespace global, Namespace local)
      => global  -- ^ Data type providing global variables dictionary
      -> local   -- ^ Data type providing local variables dictionary
@@ -776,6 +790,8 @@ eval globals locals q = runProgram $ do
 {-# SPECIALIZE eval :: Main -> Temp -> PyQuote -> Py PyObject #-}
 
 -- | Evaluate sequence of python statements
+--
+--   @since 0.2@
 exec :: (Namespace global, Namespace local)
      => global  -- ^ Data type providing global variables dictionary
      -> local   -- ^ Data type providing local variables dictionary

src/Python/Internal/Types.hs

@@ -136,6 +136,8 @@ instance PrimMonad Py where
 
 -- | Quasiquoted python code. It contains source code and closure
 --   which populates dictionary with local variables.
+--
+--   @since 0.2@
 data PyQuote = PyQuote
   { code   :: !Code
   , binder :: !DictBinder
@@ -144,20 +146,28 @@ data PyQuote = PyQuote
 
 -- | UTF-8 encoded python source code. Usually it's produced by
 --   Template Haskell's 'TH.lift' function.
+--
+--   @since 0.2@
 newtype Code = Code BS.ByteString
   deriving stock (Show, TH.Lift)
 
 -- | Create properly encoded @Code@. This function doesn't check
 --   syntactic validity.
+--
+--   @since 0.2@
 codeFromText :: T.Text -> Code
 codeFromText = Code . T.encodeUtf8
 
 -- | Create properly encoded @Code@. This function doesn't check
 --   syntactic validity.
+--
+--   @since 0.2@
 codeFromString :: String -> Code
 codeFromString = codeFromText . T.pack
 
 -- | Closure which stores values in provided dictionary
+--
+--   @since 0.2@
 newtype DictBinder = DictBinder { bind :: Ptr PyObject -> Py () }
 
 instance Semigroup DictBinder where