LIB/GTK: improve documentation

This commit is contained in:
Julian Ospald 2016-04-03 03:57:35 +02:00
parent 4e75a84439
commit 0781fc690d
No known key found for this signature in database
GPG Key ID: 511B62C09D50CD28
2 changed files with 3 additions and 3 deletions

View File

@ -19,9 +19,8 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
{-# OPTIONS_HADDOCK ignore-exports #-} {-# OPTIONS_HADDOCK ignore-exports #-}
-- |This module provides all the atomic IO related file operations like -- |This module provides all the atomic IO related file operations like
-- copy, delete, move and so on. It operates only on FilePaths and reads -- copy, delete, move and so on. It operates primarily on `AnchoredFile`, which
-- all necessary file information manually in order to stay atomic and not -- is guaranteed to be well-formed.
-- rely on the state of passed objects.
-- --
-- It would be nicer to pass states around, but the filesystem state changes -- It would be nicer to pass states around, but the filesystem state changes
-- too quickly and cannot be relied upon. Lazy implementations of filesystem -- too quickly and cannot be relied upon. Lazy implementations of filesystem

View File

@ -194,6 +194,7 @@ createTreeView = do
-- --
-- If the third argument is (Just path) it tries to read "path". If that -- If the third argument is (Just path) it tries to read "path". If that
-- fails, it reads "/" instead. -- fails, it reads "/" instead.
-- TODO: maybe move the parsing logic away and use 'Path Abs' in the type
refreshView :: MyGUI refreshView :: MyGUI
-> MyView -> MyView
-> Maybe FilePath -> Maybe FilePath