Merge pull request #1475 from jim-parry/fix3

jim-parry · web-flow · commit 85ce20b7c17c · 2018-11-12T16:12:03.000-08:00
Correct phpdocs for Forge::addField()
diff --git a/system/Database/Forge.php b/system/Database/Forge.php
@@ -340,7 +340,7 @@ public function addUniqueKey($key)
 	/**
 	 * Add Field
 	 *
-	 * @param array $field
+	 * @param array|string $field
 	 *
 	 * @return Forge
 	 */
diff --git a/user_guide_src/source/dbmgmt/forge.rst b/user_guide_src/source/dbmgmt/forge.rst
@@ -1,4 +1,3 @@
-####################
 Database Forge Class
 ####################
 
@@ -63,7 +62,7 @@ mechanism for this.
 Adding fields
 =============
 
-Fields are created via an associative array. Within the array you must
+Fields are normally created via an associative array. Within the array you must
 include a 'type' key that relates to the datatype of the field. For
 example, INT, VARCHAR, TEXT, etc. Many datatypes (for example VARCHAR)
 also require a 'constraint' key.

Original file line number	Diff line number	Diff line change
`@@ -340,7 +340,7 @@ public function addUniqueKey($key)`
`340`	`340`	`/**`
`341`	`341`	`* Add Field`
`342`	`342`	`*`
`343`		`- * @param array $field`
	`343`	`+ * @param array\|string $field`
`344`	`344`	`*`
`345`	`345`	`* @return Forge`
`346`	`346`	`*/`