[Home]

Summary:ASTERISK-26471: func_strings: Better documentation for REGEX Function, and minor text fixes
Reporter:xrobau (xrobau)Labels:
Date Opened:2016-10-16 18:27:51Date Closed:
Priority:TrivialRegression?No
Status:Open/NewComponents:Documentation Functions/func_strings
Versions:GIT Frequency of
Occurrence
Related
Issues:
Environment:Attachments:( 0) regex-2.diff
( 1) whitespace-1.diff
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'






Comments:By: Asterisk Team (asteriskteam) 2016-10-16 18:27:52.465-0500

Thanks for creating a report! The issue has entered the triage process. That means the issue will wait in this status until a Bug Marshal has an opportunity to review the issue. Once the issue has been reviewed you will receive comments regarding the next steps towards resolution.

A good first step is for you to review the [Asterisk Issue Guidelines|https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines] if you haven't already. The guidelines detail what is expected from an Asterisk issue report.

Then, if you are submitting a patch, please review the [Patch Contribution Process|https://wiki.asterisk.org/wiki/display/AST/Patch+Contribution+Process].

By: xrobau (xrobau) 2016-10-16 18:41:48.539-0500

Note that there are *two* patches attached to this. The first, 'whitespace.diff', removes trailing whitespace
from text fields in functions, which causes multiple spaces to appear in the documentation

The second patch is the REGEX patch, which does depend on whitespace.diff (or, you can manually put the spaces
back into the patch).


By: Corey Farrell (coreyfarrell) 2016-10-17 09:39:47.199-0500

Strange about the white-space.  CR, LF and tab are all whitespace, and I thought XML is supposed to replace consecutive whitespace with a single space.