[Freeipa-devel] [PATCH] 451-458 Web UI devel and source code documentation

[Ana Krivokapic]

On 10/02/2013 02:20 PM, Petr Vobornik wrote:
> On 09/16/2013 05:24 PM, Ana Krivokapic wrote:
>> On 09/11/2013 12:44 PM, Petr Vobornik wrote:
>>> Hello,
>>>
>
> snip
>
>>>
>>
>> I looked into the documentation effort and (ruby dependency discussion aside) I
>> don't have any major objections. I like how the generated pages look, and they
>> are intuitive and easy to navigate.
>>
>> A couple of nitpicks:
>>
>> 1) There are some spelling mistakes (e.g. Apllication_controller)
> Fixed
>>
>> 2) Bulleted lists are not rendered nicely in the html output (see for example
>> the doc string for _base.Builder property 'string_mode'. I think a list needs to
>> look like this in the source code:
>>
>>          /**
>>           * This is a list:
>>           *
>>           * - 'element1'
>>           * - 'element2'
>>           *
>>           */
>>
>> as opposed to this:
>>
>>          /**
>>           * This is a list:
>>           * - 'element1'
>>           * - 'element2'
>>           */
>>
>
> Fixed on many places. Also fixed the same issue in some code examples.
>
> - _base.Builder doc was heavily revised
> - added doc comments to ./plugin_loader
>
> All patches are rebased but just patches 452 and 453 are changed.

Looks good, ACK.

-- 
Regards,

Ana Krivokapic
Associate Software Engineer
FreeIPA team
Red Hat Inc.