Move documentation note about RecursiveFailure where it belongs

This commit is contained in:
Julian Ospald 2016-06-05 22:04:16 +02:00
parent a31c9d1e88
commit ce7fdcdcd6
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28

View File

@ -227,7 +227,9 @@ data FileType = Directory
-- --
-- On `CollectFailures` skips errors in the recursion and keeps on recursing. -- On `CollectFailures` skips errors in the recursion and keeps on recursing.
-- However all errors are collected in the `RecursiveFailure` error type, -- However all errors are collected in the `RecursiveFailure` error type,
-- which is raised finally if there was any error. -- which is raised finally if there was any error. Also note that
-- `RecursiveFailure` does not give any guarantees on the ordering
-- of the collected exceptions.
data RecursiveErrorMode = FailEarly data RecursiveErrorMode = FailEarly
| CollectFailures | CollectFailures
@ -263,9 +265,6 @@ data CopyMode = Strict -- ^ fail if any target exists
-- the operation has completed. Permissions of existing directories are -- the operation has completed. Permissions of existing directories are
-- fixed. -- fixed.
-- --
-- Note that there is no guaranteed ordering of the exceptions
-- contained within `RecursiveFailure` in `CollectFailures` RecursiveErrorMode.
--
-- Safety/reliability concerns: -- Safety/reliability concerns:
-- --
-- * not atomic -- * not atomic