|
definition:
|
getAnalysisDoc :: String -> IO (Maybe String)
getAnalysisDoc aname = do
let docfilename = docDir </> aname <.> "md"
docfileexists <- doesFileExist docfilename
if docfileexists then readFile docfilename >>= return . Just
else return Nothing
|
|
demand:
|
no demanded arguments
|
|
deterministic:
|
deterministic operation
|
|
documentation:
|
--------------------------------------------------------------------------
--- Gets the documentation of an analysis with a registered name.
--- Returns `Nothing` if no documentation exist.
--- The documentation of an analysis with name AN is usually stored
--- in the file `<PACKAGEROOT>/docs/AN.md`.
|
|
failfree:
|
<FAILING>
|
|
indeterministic:
|
referentially transparent operation
|
|
infix:
|
no fixity defined
|
|
iotype:
|
{(_) |-> _}
|
|
name:
|
getAnalysisDoc
|
|
precedence:
|
no precedence defined
|
|
result-values:
|
_
|
|
signature:
|
String -> Prelude.IO (Prelude.Maybe String)
|
|
solution-complete:
|
operation might suspend on free variables
|
|
terminating:
|
possibly non-terminating
|
|
totally-defined:
|
possibly non-reducible on same data term
|