package yocaml

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

Module Yocaml.LexiconSource

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...

Sourcetype t = string

Messages

Sourceval target_need_to_be_built : Filepath.t -> t

Occurs when a target need to be built.

Sourceval target_need_to_be_read : Filepath.t -> t

Occurs when a target need to be read.

Sourceval target_is_up_to_date : Filepath.t -> t

Occurs when a target is up to date.

Sourceval crap_there_is_an_error : Error.t -> t

Occurs when there is an error.

Sourceval crap_there_is_an_exception : exn -> t

Occurs when there is an exception.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct