Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion docs/exrail/exrail-command-reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,13 @@ Handy information

.. warning::

You must avoid using these characters in all descriptions: ``<``, ``>``, ``"`` as these are part of the |DCC-EX| protocol and are likely to prevent descriptions showing up in |JMRi| and other throttle software/clients.
You must avoid using these characters in all descriptions: ``<``, ``>``, ``"`` as these are part of the |DCC-EX| protocol and are likely to prevent descriptions showing up in |JMRI| and other throttle software/clients.

.. warning::

**Do not use leading zeros for any numbers!**

Any number with a leading zero will be treated as an octal number, so for example ``ALIAS(MY_ALIAS, 010)`` will assign the value of ``8`` to MY_ALIAS, not ``10``. This is a common mistake that can lead to very confusing behavior if you don't know about it. Always use numbers without leading zeros, for example ``ALIAS(MY_ALIAS, 10)`` to assign the value of 10 to MY_ALIAS.

.. note::

Expand Down
6 changes: 6 additions & 0 deletions docs/exrail/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,12 @@ For a full list of keywords, see :doc:`/exrail/exrail-command-reference`. Only

Do not waste your time asking ChatGPT, Copilot or Gemini to create EXRAIL scripts. They do not understand EXRAIL and will get it wrong 100% of the time.

.. warning::

**Do not use leading zeros for any numbers!**

Any number with a leading zero will be treated as an octal number, so for example ``ALIAS(MY_ALIAS, 010)`` will assign the value of ``8`` to MY_ALIAS, not ``10``. This is a common mistake that can lead to very confusing behavior if you don't know about it. Always use numbers without leading zeros, for example ``ALIAS(MY_ALIAS, 10)`` to assign the value of 10 to MY_ALIAS.

Types of Sequence
=================

Expand Down
7 changes: 7 additions & 0 deletions docs/exrail/tips.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,13 @@ Below are some tips and techniques you can implement to get the most out of |EX-

Do not waste your time asking ChatGPT, Copilot or Gemini to create EXRAIL scripts. They do not understand EXRAIL and will get it wrong 100% of the time.

Numbers and Leading Zeros
==========================

**Do not use leading zeros for any numbers!**

Any number with a leading zero will be treated as an octal number, so for example ``ALIAS(MY_ALIAS, 010)`` will assign the value of ``8`` to MY_ALIAS, not ``10``. This is a common mistake that can lead to very confusing behavior if you don't know about it. Always use numbers without leading zeros, for example ``ALIAS(MY_ALIAS, 10)`` to assign the value of 10 to MY_ALIAS.

Comments
========

Expand Down
Loading