diff --git a/docs/source/programming.rst b/docs/source/programming.rst index 0b4640ba8..de11f416d 100644 --- a/docs/source/programming.rst +++ b/docs/source/programming.rst @@ -642,7 +642,7 @@ Subroutines can be defined in a Block, but also nested inside another subroutine With ``asmsub`` you can define a low-level subroutine that is implemented in inline assembly and takes any parameters in registers directly. -Trivial subroutines can be tagged as inline to tell the compiler to copy their code +Trivial subroutines can be tagged as ``inline`` to tell the compiler to copy their code in-place to the locations where the subroutine is called, rather than inserting an actual call and return to the subroutine. This may increase code size significantly and can only be used in limited scenarios, so YMMV. diff --git a/docs/source/syntaxreference.rst b/docs/source/syntaxreference.rst index d5882745e..8e70ec69b 100644 --- a/docs/source/syntaxreference.rst +++ b/docs/source/syntaxreference.rst @@ -550,7 +550,7 @@ and can have nothing following it. The close curly brace must be on its own line The parameters is a (possibly empty) comma separated list of " " pairs specifying the input parameters. The return type has to be specified if the subroutine returns a value. The ``inline`` keyword makes their code copied in-place to the locations where the subroutine is called, -rather than having an actual call and return to the subroutine. This is meant for trivial subroutines only +rather than having an actual call and return to the subroutine. This is meant for very small subroutines only as it can increase code size significantly.