package yocaml

  1. Overview
  2. Docs
On This Page
  1. Types
  2. Messages
package yocaml
Legend:
Library
Module
Module type
Parameter
Class
Class type

A centralisation of feedback messages.

As I have already quietly mentioned, feedback is important to the user. So this module essentially exposes functions to produce strings of characters... for example, "Ah, this file was successfully created" or "Hmm, the task failed miserably with 'the error in question'".

Types

At the moment it would seem (obviously) that a string is an ideal tool to display messages...

type t = string

Messages

val target_need_to_be_built : Filepath.t -> t

Occurs when a target need to be built.

val target_need_to_be_read : Filepath.t -> t

Occurs when a target need to be read.

val target_is_up_to_date : Filepath.t -> t

Occurs when a target is up to date.

val crap_there_is_an_error : Error.t -> t

Occurs when there is an error.

val crap_there_is_an_exception : exn -> t

Occurs when there is an exception.