documentation icon indicating copy to clipboard operation
documentation copied to clipboard

docs: rewrite pattern matching documentation

Open arthursimas1 opened this issue 1 year ago • 7 comments

This PR proposes a rewrite in the pattern matching documentation for better clarity and organization.

I first started to fix the final section about Matching on Caller ID, but then I realized that the whole document could be further improved.

I'm willing to change it based on your suggestions.


I need some clarification:

  • Special Symbols The only characters with special meaning within a set are the '-' character, to define a range between two characters, the '\' character to escape a special character available within a set, and

What is the other character with special meaning? Notice the final and ...

  • Auto-Fallthrough Please be aware that because of the way auto-fallthrough works, if Asterisk can't find the next priority number for the current extension or pattern match, it will also look for that same priority in a less specific pattern match.

If I write it as "it will look for that next priority in a less specific pattern match", does it still represents the correct behaviour? I thought it's clearer.

  • Wildcards

Only ! is used for overlap dialing or . can also be used? Is this the difference that the old text was talking about?

  • Overlap dialing

I couldn't find nothing regarding overlap dialing on the Asterisk docs. Does this page exist? We could link it here. If it's missing, we can write something in that matter (example)


Resolves: https://github.com/asterisk/documentation/issues/56

arthursimas1 avatar Feb 22 '24 09:02 arthursimas1

@jcolp @gtjoseph

arthursimas1 avatar Feb 22 '24 09:02 arthursimas1

@arthursimas1 Thanks for the contribution! It's a lot so it'll probably take us a few days to get through it.

gtjoseph avatar Feb 22 '24 13:02 gtjoseph

Yeah, I perfectly understand. Take your time! (just don't forget about it 😂)

arthursimas1 avatar Feb 22 '24 13:02 arthursimas1

CLA assistant check
All committers have signed the CLA.

sangoma-oss-cla[bot] avatar Feb 22 '24 18:02 sangoma-oss-cla[bot]

@jms72 I really appreciate the time you spent to review this. Thank you!

arthursimas1 avatar Feb 23 '24 12:02 arthursimas1

I'm closing and re-opening this PR so it triggers the new workflow job that does a temporary build.

gtjoseph avatar Mar 14 '24 11:03 gtjoseph

Thanks all for the review! I'll take a look into it in the following days (the PR isn't abandoned!)

arthursimas1 avatar Mar 28 '24 07:03 arthursimas1