[asterisk-bugs] [JIRA] (ASTERISK-26471) Better documentation for REGEX Function, and minor text fixes

[xrobau (JIRA)]

     [ https://issues.asterisk.org/jira/browse/ASTERISK-26471?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

xrobau updated ASTERISK-26471:
------------------------------

    Description: 
The 'REGEX' function's documentation is sparse and needs improvement.

A suggested update is attached as a diff.

There is also a 'whitespace.diff' which removes trailing whitespace from text entries, removing double spaces.

{code}
  -= Info about function 'SHARED' =-

[Synopsis]
Gets or sets the shared variable specified.

[Description]
Implements a shared variable area, in which you may share variables between
channels.
The variables used in this space are separate from the general namespace of the
channel and thus ${SHARED(foo)} and ${foo}  represent two completely different
variables, despite sharing the same name.
{code}

Note how there is two spaces between $\{foo} and 'represent'








  was:
The 'REGEX' function's documentation is sparse and needs improvement.

A suggested update is attached as a diff.

There is also a 'whitespace.diff' which removes trailing whitespace from text entries, removing double spaces.

{code}
  -= Info about function 'SHARED' =-

[Synopsis]
Gets or sets the shared variable specified.

[Description]
Implements a shared variable area, in which you may share variables between
channels.
The variables used in this space are separate from the general namespace of the
channel and thus ${SHARED(foo)} and ${foo}  represent two completely different
variables, despite sharing the same name.
{code}

Note how there is two spaces between ${foo} and 'represent'









> Better documentation for REGEX Function, and minor text fixes
> -------------------------------------------------------------
>
>                 Key: ASTERISK-26471
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-26471
>             Project: Asterisk
>          Issue Type: Improvement
>      Security Level: None
>          Components: Functions/func_strings
>    Affects Versions: GIT
>            Reporter: xrobau
>            Severity: Trivial
>         Attachments: regex-2.diff, whitespace-1.diff
>
>
> The 'REGEX' function's documentation is sparse and needs improvement.
> A suggested update is attached as a diff.
> There is also a 'whitespace.diff' which removes trailing whitespace from text entries, removing double spaces.
> {code}
>   -= Info about function 'SHARED' =-
> [Synopsis]
> Gets or sets the shared variable specified.
> [Description]
> Implements a shared variable area, in which you may share variables between
> channels.
> The variables used in this space are separate from the general namespace of the
> channel and thus ${SHARED(foo)} and ${foo}  represent two completely different
> variables, despite sharing the same name.
> {code}
> Note how there is two spaces between $\{foo} and 'represent'



--
This message was sent by Atlassian JIRA
(v6.2#6252)