[asterisk-dev] [Code Review] Documentation for the timing modules used in Asterisk

[Mark Michelson]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://reviewboard.digium.com/r/164/#review449
-----------------------------------------------------------



/trunk/doc/timing.txt
<http://reviewboard.digium.com/r/164/#comment1074>

    After looking at the new diff, I noticed that reviewboard has noted all the trailing whitespace in the doc. I actually placed those there on purpose so that if the document needs to be edited later, it is easy to maintain the proper spacing between words that end a line and words that start a line.
    
    The "requiredfor" grammatical mistake on this line is the direct result of not having a trailing whitespace on a line that previously had "required" at the end and a followup line that began with "for"
    
    To me, it is actually more of a mistake that there are some lines which fail to end with a trailing space.


- Mark


On 2009-02-17 13:42:16, Mark Michelson wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://reviewboard.digium.com/r/164/
> -----------------------------------------------------------
> 
> (Updated 2009-02-17 13:42:16)
> 
> 
> Review request for Asterisk Developers and Russell Bryant.
> 
> 
> Summary
> -------
> 
> This provides documentation for the timing modules used in Asterisk beginning with Asterisk 1.6.1. The documentation provided here is dependent upon the work on review http://reviewboard.digium.com/r/162/ being placed into Asterisk.
> 
> This first upload is a rough draft, and I expect to hear quite a bit of feedback on how to improve it. I suspect that not everything that I've said is 100% accurate either, especially with regards to the timing tests described in the "What Asterisk Does with the Timing Interface" section.
> 
> 
> Diffs
> -----
> 
>   /trunk/doc/timing.txt PRE-CREATION 
>   /trunk/res/res_timing_dahdi.c 176252 
> 
> Diff: http://reviewboard.digium.com/r/164/diff
> 
> 
> Testing
> -------
> 
> How exactly does one test documentation?
> 
> 
> Thanks,
> 
> Mark
> 
>