.. index:: tutor
.. _tutor/0:

.. rst-class:: right

**object**

``tutor``
=========

This object adds explanations and suggestions to selected compiler warning and error messages.

| **Availability:** 
|    ``logtalk_load(tutor(loader))``

| **Author:** Paulo Moura
| **Version:** 0:80:0
| **Date:** 2024-12-13

| **Compilation flags:**
|    ``static, context_switching_calls``


| **Provides:**
|    :ref:`logtalk::message_hook/4 <logtalk/0::message_hook/4>`
| **Uses:**
|    :ref:`list <list/0>`
|    :ref:`logtalk <logtalk/0>`

| **Remarks:**

   - Usage: Simply load this object at startup using the goal ``logtalk_load(tutor(loader))``.

| **Inherited public predicates:**
|    (none)

.. contents::
   :local:
   :backlinks: top

Public predicates
-----------------

.. index:: explain//1
.. _tutor/0::explain//1:

``explain//1``
^^^^^^^^^^^^^^

Generates an explanation for a message.

| **Compilation flags:**
|    ``static``

| **Template:**
|    ``explain(Message)``
| **Mode and number of proofs:**
|    ``explain(@callable)`` - ``zero_or_one``


------------

Protected predicates
--------------------

(no local declarations; see entity ancestors if any)

Private predicates
------------------

(no local declarations; see entity ancestors if any)

Operators
---------

(none)