[asterisk-dev] [Code Review] 2823: Documentation fix and improvements to XML configuration help res_pjsip_acl

[Mark Michelson]

> On Sept. 4, 2013, 9:03 p.m., Mark Michelson wrote:
> >

Hmm, I left some general feedback in my review that seems to have been swallowed by Internet goblins. Here's what should have been present.

* Capitalization is a bit off in certain cases. It's customary when describing SIP headers to capitalize the name of the header (e.g. "Contact") but not the word "header". In addition, there are some parts that you did not change where the words "permit" and "deny" are capitalized despite not being the first word in the sentence.
* It's a bit wordy to mention that an option may be either an individual item or a comma-delimited list of items. If you just mention that it's a comma-delimited list of items, that implies the case where a list of only one item is present.


- Mark


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://reviewboard.asterisk.org/r/2823/#review9590
-----------------------------------------------------------


On Sept. 4, 2013, 7:59 p.m., rnewton wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://reviewboard.asterisk.org/r/2823/
> -----------------------------------------------------------
> 
> (Updated Sept. 4, 2013, 7:59 p.m.)
> 
> 
> Review request for Asterisk Developers.
> 
> 
> Bugs: ASTERISK-22458
>     https://issues.asterisk.org/jira/browse/ASTERISK-22458
> 
> 
> Repository: Asterisk
> 
> 
> Description
> -------
> 
> One bug fix. The synopsis for "type" was wrong.
> 
> When Mark and I were looking at some ACL issue we noted that there should be some improvements to the documentation.
> 
> Notably:
> 
>  *  changing the usage of "IP-domains" to "IP addresses"
>  *  clarifying the usage for the options, by adding a relevant description for each
>  *  modified other areas of the XML help for clarity, such as the module description and a few synopsis changes here and there. See the patch.
> 
> 
> Diffs
> -----
> 
>   /branches/12/res/res_pjsip_acl.c 398277 
> 
> Diff: https://reviewboard.asterisk.org/r/2823/diff/
> 
> 
> Testing
> -------
> 
> 
> Thanks,
> 
> rnewton
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.digium.com/pipermail/asterisk-dev/attachments/20130904/5961f2f4/attachment.htm>