From: Koosha Khajeh Moogahi <koosha.khajeh@gmail.com>
Date: Sun, 17 Jun 2012 12:15:57 +0000 (+0200)
Subject: Bug 765315: Mention the data type of 'product' param in POD of Bugzilla::Component... 
X-Git-Tag: bugzilla-4.3.2~42
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=35bf9943a87018e6cfa2d49f83f77c22205ddfc0;p=thirdparty%2Fbugzilla.git

Bug 765315: Mention the data type of 'product' param in POD of Bugzilla::Component->new to avoid misunderstanding
r/a=LpSolit
---

diff --git a/Bugzilla/Component.pm b/Bugzilla/Component.pm
index 5be6a4240e..f189639468 100644
--- a/Bugzilla/Component.pm
+++ b/Bugzilla/Component.pm
@@ -487,10 +487,12 @@ Component.pm represents a Product Component object.
 
  Params:      $param - If you pass an integer, the integer is the
                        component ID from the database that we want to
-                       read in. If you pass in a hash with the 'name'
-                       and 'product' keys, then the value of the name
-                       key is the name of a component being in the given
-                       product.
+                       read in. 
+                       However, If you pass in a hash, it must contain
+                       two keys:
+                       name (string): the name of the component
+                       product (object): an object of Bugzilla::Product
+                       representing the product that the component belongs to.
 
  Returns:     A Bugzilla::Component object.