github.com/lmorg/murex@v0.0.0-20240217211045-e081c89cd4ef/gen/variables/numeric_doc.yaml (about)

     1  - DocumentID: numeric
     2    Title: >-
     3      Numeric (str)
     4    CategoryID: variables
     5    Summary: >-
     6      Variables who's name is a positive integer, eg `0`, `1`, `2`, `3` and above
     7    Description: |-
     8      Variables named `0` and above are the equivalent index value of `@ARGV`.
     9  
    10      These are reserved variable so they cannot be changed.
    11    Examples: |-
    12      ```
    13      » function example { out $0 $2 }
    14      » example 1 2 3
    15      example 2
    16      ```
    17    Detail: |-
    18      ### `0` (str)
    19  
    20      This returns the name of the executable (like `$ARGS[0]`)
    21  
    22      ### `1`, `2`, `3`... (str)
    23  
    24      This returns parameter _n_ (like `$ARGS[n]`). If there is no parameter _n_
    25      then the variable will not be set thus the upper limit variable is determined
    26      by how many parameters are set. For example if you have 19 parameters passed
    27      then variables `$1` through to `$19` (inclusive) will all be set.
    28    Synonyms:
    29    Related:
    30    - argv
    31    - params
    32    - set
    33    - string
    34    - function
    35    - private
    36    - autocomplete
    37    - out