Project

General

Profile

action #93306

Updated by oorlov over 3 years ago

## Motivation 

 There are almost no comments in LibyuiClient perl lib, we should document it. it: 

 ## Task 

 1. - Add a Documentation file like we have for the POM framework (https://github.com/os-autoinst/os-autoinst-distri-opensuse/blob/master/ui-framework-documentation.md).  
 Could contain a "step by step" guide like in the POM framework doc, in which we could put a link to the new doc. 
 - Put comments in the perl files themselves, using [Perl POD](https://perldoc.perl.org/perlpod) (This can be in POD. This should be made in https://github.com/qe-yast/perl-yui-rest-client, as we have plans to use LibyuiClient as cpan module); 
 2. Ruby client is well documented, so it could be used as reference: https://github.com/qe-yast/ruby-yui-rest-client/tree/master/lib/yui_rest_client (but please, try to avoid out-dated information as it was written some time ago). module.

Back