@@ -62,7 +62,7 @@ parseResponse (Right response) =
62getDockerVersion :: forall m. Monad m => DockerT m (Either DockerError DockerVersion)
62getDockerVersion :: forall m. Monad m => DockerT m (Either DockerError DockerVersion)
63getDockerVersion = requestHelper GET VersionEndpoint >>= parseResponse
63getDockerVersion = requestHelper GET VersionEndpoint >>= parseResponse
65−-- | Lists all running docker containers. Pass in defaultListOpts {all
65+-- | Lists all running docker containers. Pass in 'defaultListOpts' {all
66-- = True} to get a list of stopped containers as well.
66-- = True} to get a list of stopped containers as well.
67listContainers :: forall m. Monad m => ListOpts -> DockerT m (Either DockerError [Container])
67listContainers :: forall m. Monad m => ListOpts -> DockerT m (Either DockerError [Container])
68listContainers opts = requestHelper GET (ListContainersEndpoint opts) >>= parseResponse
68listContainers opts = requestHelper GET (ListContainersEndpoint opts) >>= parseResponse
@@ -72,14 +72,14 @@ listImages :: forall m. Monad m => ListOpts -> DockerT m (Either DockerError [Im
72listImages opts = requestHelper GET (ListImagesEndpoint opts) >>= parseResponse
72listImages opts = requestHelper GET (ListImagesEndpoint opts) >>= parseResponse
74-- | Creates a docker container but does *not* start it. See
74-- | Creates a docker container but does *not* start it. See
75−-- "CreateOpts" for a list of options and you can use "defaultCreateOpts"
75+-- "CreateOpts" for a list of options and you can use 'defaultCreateOpts'
76-- for some sane defaults.
76-- for some sane defaults.
77createContainer :: forall m. Monad m => CreateOpts -> DockerT m (Either DockerError ContainerID)
77createContainer :: forall m. Monad m => CreateOpts -> DockerT m (Either DockerError ContainerID)
78createContainer opts = requestHelper POST (CreateContainerEndpoint opts) >>= parseResponse
78createContainer opts = requestHelper POST (CreateContainerEndpoint opts) >>= parseResponse
80-- | Start a container from a given "ContainerID" that we get from
80-- | Start a container from a given "ContainerID" that we get from
81−-- "createContainer". See "StartOpts" for a list of configuration options
81+-- 'createContainer'. See "StartOpts" for a list of configuration options
82−-- for starting a container. Use "defaultStartOpts" for sane defaults.
82+-- for starting a container. Use 'defaultStartOpts' for sane defaults.
83startContainer :: forall m. Monad m => StartOpts -> ContainerID -> DockerT m (Either DockerError ())
83startContainer :: forall m. Monad m => StartOpts -> ContainerID -> DockerT m (Either DockerError ())
84startContainer sopts cid = requestUnit POST $ StartContainerEndpoint sopts cid
84startContainer sopts cid = requestUnit POST $ StartContainerEndpoint sopts cid
@@ -108,7 +108,7 @@ unpauseContainer :: forall m. Monad m => ContainerID -> DockerT m (Either Docker
108unpauseContainer cid = requestUnit GET $ UnpauseContainerEndpoint cid
108unpauseContainer cid = requestUnit GET $ UnpauseContainerEndpoint cid
110-- | Deletes a container with the given "ContainerID".
110-- | Deletes a container with the given "ContainerID".
111−-- See "DeleteOpts" for options and use "defaultDeleteOpts" for sane
111+-- See "DeleteOpts" for options and use 'defaultDeleteOpts' for sane
112-- defaults.
112-- defaults.
113deleteContainer :: forall m. Monad m => DeleteOpts -> ContainerID -> DockerT m (Either DockerError ())
113deleteContainer :: forall m. Monad m => DeleteOpts -> ContainerID -> DockerT m (Either DockerError ())
114deleteContainer dopts cid = requestUnit DELETE $ DeleteContainerEndpoint dopts cid
114deleteContainer dopts cid = requestUnit DELETE $ DeleteContainerEndpoint dopts cid
@@ -119,10 +119,10 @@ inspectContainer cid = requestHelper GET (InspectContainerEndpoint cid) >>= pars
120-- | Get's container's logs for a given "ContainerID".
120-- | Get's container's logs for a given "ContainerID".
121-- This will only work with the "JsonFile" "LogDriverType" as the other driver types disable
121-- This will only work with the "JsonFile" "LogDriverType" as the other driver types disable
122−-- this endpoint and it will return a DockerError.
122+-- this endpoint and it will return a "DockerError".
124-- See "LogOpts" for options that you can pass and
124-- See "LogOpts" for options that you can pass and
125−-- "defaultLogOpts" for sane defaults.
125+-- 'defaultLogOpts' for sane defaults.
127-- __NOTE__: Currently streaming logs is
127-- __NOTE__: Currently streaming logs is
128-- not supported and this function will fetch the entire log that the
128-- not supported and this function will fetch the entire log that the