@@ -62,7 +62,7 @@ parseResponse (Right response) =
6262getDockerVersion :: forall m. Monad m => DockerT m (Either DockerError DockerVersion)
6363getDockerVersion = requestHelper GET VersionEndpoint >>= parseResponse
6464
65−-- | Lists all running docker containers. Pass in defaultListOpts {all
65+-- | Lists all running docker containers. Pass in 'defaultListOpts' {all
6666-- = True} to get a list of stopped containers as well.
6767listContainers :: forall m. Monad m => ListOpts -> DockerT m (Either DockerError [Container])
6868listContainers opts = requestHelper GET (ListContainersEndpoint opts) >>= parseResponse
@@ -72,14 +72,14 @@ listImages :: forall m. Monad m => ListOpts -> DockerT m (Either DockerError [Im
7272listImages opts = requestHelper GET (ListImagesEndpoint opts) >>= parseResponse
7373
7474-- | 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'
7676-- for some sane defaults.
7777createContainer :: forall m. Monad m => CreateOpts -> DockerT m (Either DockerError ContainerID)
7878createContainer opts = requestHelper POST (CreateContainerEndpoint opts) >>= parseResponse
7979
8080-- | Start a container from a given "ContainerID" that we get from
81−-- "createContainer". See "StartOpts" for a list of configuration options
82−-- for starting a container. Use "defaultStartOpts" for sane defaults.
81+-- 'createContainer'. See "StartOpts" for a list of configuration options
82+-- for starting a container. Use 'defaultStartOpts' for sane defaults.
8383startContainer :: forall m. Monad m => StartOpts -> ContainerID -> DockerT m (Either DockerError ())
8484startContainer sopts cid = requestUnit POST $ StartContainerEndpoint sopts cid
8585
@@ -108,7 +108,7 @@ unpauseContainer :: forall m. Monad m => ContainerID -> DockerT m (Either Docker
108108unpauseContainer cid = requestUnit GET $ UnpauseContainerEndpoint cid
109109
110110-- | 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
112112-- defaults.
113113deleteContainer :: forall m. Monad m => DeleteOpts -> ContainerID -> DockerT m (Either DockerError ())
114114deleteContainer dopts cid = requestUnit DELETE $ DeleteContainerEndpoint dopts cid
@@ -119,10 +119,10 @@ inspectContainer cid = requestHelper GET (InspectContainerEndpoint cid) >>= pars
119119
120120-- | Get's container's logs for a given "ContainerID".
121121-- 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".
123123--
124124-- See "LogOpts" for options that you can pass and
125−-- "defaultLogOpts" for sane defaults.
125+-- 'defaultLogOpts' for sane defaults.
126126--
127127-- __NOTE__: Currently streaming logs is
128128-- not supported and this function will fetch the entire log that the