Project

General

Profile

coordination #50510

coordination #50507: [qe-core][functional][saga] document lib/ functions

[qe-core][functional][epic] write documentation for lib/ functions

Added by jorauch over 2 years ago. Updated about 1 month ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Enhancement to existing tests
Target version:
SUSE QA - Milestone 31
Start date:
2019-05-20
Due date:
% Done:

100%

Estimated time:
(Total: 0.00 h)
Difficulty:

Description

Each function in the lib/ folder needs to be documented with POD

AC

  • AC1: Most of the functions are documented
  • AC2: Undocumented functions are marked as undocumented
  • AC3: each function in lib/ has a POD block that explains it

How to write the documentation

  • At level one we have the name of the module and a short synopsis with brief description
  • At level two we have the names of each functions before the functions
=head1 MY_MODULE

=head1 SYNOPSIS

    use lib::my_module

This is a module that does foobar

=cut

use testapi
use stuff
use other_stuff

=head2 my_function

 my_function($arg1, $arg2); 

a single space before it is required!

format for list item:

=over

=item * list 1

=item * list 2

=back

This is a function that does nothing because it's for documentation purposes

Describe here also, what C<$arg1> and C<$arg2> will do and also cover what the function returns if applicable.

=cut
sub my_function {}


Subtasks

action #51644: [functional][u] write documentation for lib/susedistributionResolvedjorauch

action #51647: [functional][u] write documentation for lib/known_bugsResolvedjorauch

action #54671: [sle][functional] write documentation for lib/version_utilsResolvedjorauch

action #54677: [sle][functional] write documentation for opensusebasetestResolveddheidler

action #56156: [functional][u] write documentation for lib/Utils/Architectures.pmResolvedzluo

action #56258: [functional][u] write documentation for lib/autofs_utils.pmResolvedzluo

action #57038: [sle][functional] write documentation for lib/suseconnect_register.pmResolvedzluo

action #57062: [sle][functional] write documentation for lib/apachetest.pmResolvedzluo

action #57128: [sle][functional] write documentation for lib/autofs_test.pmResolvedzluo

action #57209: [sle][functional][u] write documentation for lib/repo_tools.pmResolvedzluo

action #57302: [sle][functional][u] write documentation for lib/autoyast.pmResolvedzluo

action #57332: [sle][functional][u]write documentation for lib/rescuecdstep.pmResolvedzluo

action #57365: [sle][functional][u] write documentation for lib/service_check.pmResolvedzluo

action #57428: [sle][functional][u] write documentation for lib/s390base.pmResolvedzluo

action #57449: [sle][functional][u] extend and correct documentation for lib/data_integrity_utils.pmResolvedzluo

action #57458: [sle][functional][u] correct documentation for lib/network_utils.pmResolvedzluo

action #57518: [sle][functional][u] extend and correct documentation for lib/xml_utils.pmResolvedzluo

action #57566: [sle][functional][u] extend documentation for lib/y2lan_restart_common.pmResolvedzluo

action #57572: [functional][u] write doc for lib/networkdbase.pmResolveddheidler

action #57581: [functional][u] write doc for lib/thunderbird_common.pmResolveddheidler

action #57740: [sle][functional][u] write documentation for lib/bootloader_spvm.pmResolvedzluo

action #57752: [sle][functional][u] write documentation for lib/partition_setupResolvedjorauch

action #57761: [sle][functional][u] Extend documentation for lib/power_action_utils.pmResolvedzluo

action #57800: [sle][functional][u] extend documentation for lib/y2_module_basetest.pmResolvedzluo

action #57824: [sle][functional][u] correct and extend documentation for lib/y2_module_guitest.pmResolvedzluo

action #57839: [sle][functional][u] correct documentation for lib/yast2_widget_utils.pmResolvedzluo

action #57917: [sle][functional][u] extend documentation for lib/partition_setup.pmResolvedzluo

action #58136: [functional][u] write documentation for lib/x11utilsResolvedjorauch

action #58142: [functional][u] write documentation for lib/y2snapper_common.pmResolvedzluo

action #58190: [functional][u] document lib/web_browserResolvedjorauch

action #58202: [functional][u] write documentation for lib/y2_mm_common.pmResolvedzluo

action #58271: [functional][u] Write documentation for lib/xen.pmResolvedzluo

History

#1 Updated by SLindoMansilla about 2 years ago

  • Target version changed from Milestone 24 to Milestone 25

#2 Updated by SLindoMansilla about 2 years ago

  • Description updated (diff)
  • Status changed from New to Workable

#3 Updated by jorauch about 2 years ago

  • Description updated (diff)

#6 Updated by szarate about 2 years ago

  • Description updated (diff)

#7 Updated by szarate about 2 years ago

  • Description updated (diff)

#8 Updated by mgriessmeier about 2 years ago

  • Target version changed from Milestone 25 to Milestone 26

#9 Updated by mgriessmeier almost 2 years ago

  • Target version changed from Milestone 26 to Milestone 27

#10 Updated by dheidler almost 2 years ago

  • Status changed from Workable to In Progress
  • Assignee set to dheidler

#12 Updated by dheidler almost 2 years ago

  • Precedes action #50519: [functional][u] extend utils documentation to all lib/functions added

#13 Updated by dheidler almost 2 years ago

  • Precedes deleted (action #50519: [functional][u] extend utils documentation to all lib/functions)

#14 Updated by dheidler almost 2 years ago

  • Subject changed from [functional][u] write documentation for lib/ functions to [functional][u][epic] write documentation for lib/ functions

#15 Updated by dheidler almost 2 years ago

  • Status changed from Feedback to Workable

There are more subtasks to be done

#16 Updated by mgriessmeier almost 2 years ago

  • Target version changed from Milestone 27 to Milestone 28

#17 Updated by zluo almost 2 years ago

  • Description updated (diff)

#18 Updated by dheidler almost 2 years ago

  • Description updated (diff)

#19 Updated by mgriessmeier over 1 year ago

  • Target version changed from Milestone 28 to Milestone 31

#20 Updated by szarate 10 months ago

  • Tracker changed from action to coordination
  • Status changed from Workable to New
  • Difficulty deleted (easy)

#22 Updated by tjyrinki_suse 9 months ago

  • Subject changed from [functional][u][epic] write documentation for lib/ functions to [qe-core][functional][epic] write documentation for lib/ functions

#23 Updated by dheidler about 1 month ago

  • Assignee deleted (dheidler)

Unassigning for now as I'm with the tools team for the next months

Also available in: Atom PDF