Update with_controller_class type documentation (#2094)

TastyPi · joelhawksley · web-flow · commit fe39b4d79750 · 2024-09-16T13:47:48.000-06:00
* Update `with_controller_class` type documentation

* Updated CHANGELOG.md

---------

Co-authored-by: Joel Hawksley &lt;joel@hawksley.org&gt;
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -42,6 +42,10 @@ nav_order: 5
 
     *Petrik de Heus*
 
+* Fixed type declaration for `ViewComponent::TestHelpers.with_controller_class` parameter.
+
+    *Graham Rogers*
+
 ## 3.14.0
 
 * Defer to built-in caching for language environment setup, rather than manually using `actions/cache` in CI.
diff --git a/lib/view_component/test_helpers.rb b/lib/view_component/test_helpers.rb
@@ -155,7 +155,7 @@ def with_variant(variant)
     # end
     # ```
     #
-    # @param klass [ActionController::Base] The controller to be used.
+    # @param klass [Class<ActionController::Base>] The controller to be used.
     def with_controller_class(klass)
       old_controller = defined?(@vc_test_controller) && @vc_test_controller
 

Original file line number	Diff line number	Diff line change
`@@ -155,7 +155,7 @@ def with_variant(variant)`
`155`	`155`	`# end`
`156`	`156`	# ```
`157`	`157`	`#`
`158`		`- # @param klass [ActionController::Base] The controller to be used.`
	`158`	`+ # @param klass [Class<ActionController::Base>] The controller to be used.`
`159`	`159`	`def with_controller_class(klass)`
`160`	`160`	`old_controller = defined?(@vc_test_controller) && @vc_test_controller`
`161`	`161`