Fix Roact.forwardRef description (#312)

Fixes the Roact.forwardRef description which is currentlyRoact.createRef instead.
Roblox · Jul 9, 2021 · d4f4a7a · d4f4a7a
1 parent fe67d5e
commit d4f4a7a
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 # Roact Changelog
 
 ## Unreleased Changes
+* Fixed forwardRef description ([#312](https://github.com/Roblox/roact/pull/312)).
 
 ## [1.4.0](https://github.com/Roblox/roact/releases/tag/v1.4.0) (November 19th, 2020)
 * Introduce forwardRef ([#307](https://github.com/Roblox/roact/pull/307)).

diff --git a/docs/api-reference.md b/docs/api-reference.md
@@ -184,7 +184,7 @@ Creates a new reference object that can be used with [Roact.Ref](#roactref).
 !!! success "Added in Roact 1.4.0"
 
 ```
-Roact.createRef(render: (props: table, ref: Ref) -> RoactElement) -> RoactComponent
+Roact.forwardRef(render: (props: table, ref: Ref) -> RoactElement) -> RoactComponent
 ```
 
 Creates a new component given a render function that accepts both props and a ref, allowing a ref to be forwarded to an underlying host component via [Roact.Ref](#roactref).