[PATCH] testbot: Small package documentation tweaks.

Francois Gouget fgouget at codeweavers.com
Wed Mar 21 20:01:22 CDT 2018


Signed-off-by: Francois Gouget <fgouget at codeweavers.com>
---
 testbot/lib/WineTestBot/RecordGroups.pm |  2 +-
 testbot/lib/WineTestBot/StepsTasks.pm   | 14 ++++++++------
 testbot/lib/WineTestBot/Users.pm        |  2 +-
 3 files changed, 10 insertions(+), 8 deletions(-)

diff --git a/testbot/lib/WineTestBot/RecordGroups.pm b/testbot/lib/WineTestBot/RecordGroups.pm
index dfa83aeac..426bf60c3 100644
--- a/testbot/lib/WineTestBot/RecordGroups.pm
+++ b/testbot/lib/WineTestBot/RecordGroups.pm
@@ -21,7 +21,7 @@ package WineTestBot::RecordGroup;
 
 =head1 NAME
 
-WineTestBot::RecordGroup - a group of related history records
+WineTestBot::RecordGroup - A group of related history records
 
 =head1 DESCRIPTION
 
diff --git a/testbot/lib/WineTestBot/StepsTasks.pm b/testbot/lib/WineTestBot/StepsTasks.pm
index 79216d4e1..5f9b2ca98 100644
--- a/testbot/lib/WineTestBot/StepsTasks.pm
+++ b/testbot/lib/WineTestBot/StepsTasks.pm
@@ -22,12 +22,7 @@ package WineTestBot::StepTask;
 
 =head1 NAME
 
-WineTestBot::StepTask - Merged job steps/tasks
-
-=head1 DESCRIPTION
-
-This ties together a given WineTestBot::Task object with the corresponding
-WineTestBot::Step object.
+WineTestBot::StepTask - Merged Step + Task object
 
 =cut
 
@@ -93,6 +88,13 @@ package WineTestBot::StepsTasks;
 
 WineTestBot::StepsTasks - A collection of StepsTasks objects
 
+=head1 DESCRIPTION
+
+Provides a flat collection of all the tasks in the specified Job.
+
+Note that this is an in-memory only collection since it does not correspond to
+a specific database table.
+
 =cut
 
 use ObjectModel::BasicPropertyDescriptor;
diff --git a/testbot/lib/WineTestBot/Users.pm b/testbot/lib/WineTestBot/Users.pm
index b9745d804..e9aba5743 100644
--- a/testbot/lib/WineTestBot/Users.pm
+++ b/testbot/lib/WineTestBot/Users.pm
@@ -22,7 +22,7 @@ package WineTestBot::User;
 
 =head1 NAME
 
-WineTestBot::Users - A User
+WineTestBot::User - A User
 
 =cut
 
-- 
2.16.2



More information about the wine-devel mailing list