built-in method

# `syntax_error/1`

## Description

    syntax_error(Description)

Throws a syntax error. Used when the sequence of characters being read are not syntactically valid. This built-in method is declared private and thus cannot be used as a message to an object. Calling this predicate is equivalent to the following sequence of goals:

    ...,
    context(Context),
    throw(error(syntax_error(Description), Context)).

This allows the user to generate errors in the same format used by the runtime.

## Modes and number of proofs

    syntax_error(@nonvar) - error

## Errors

When called:
`syntax_error(Description)`

## Examples

(none)

See also

catch/3, throw/1, context/1, instantiation_error/0, uninstantiation_error/1, type_error/2, domain_error/2, consistency_error/3, existence_error/2, permission_error/3, representation_error/1, system_error/0 resource_error/1