Skip to content

Commit 1ef3241

Browse files
authored
Clarify documentation for turbomodules (#3787)
* Clarify documentation for turbomodules `codegenConfig` is stated in text that it's an array, but in code example it's an object. Either the text or the code example should change. * Fix linting issue * Update the PR to reflect knowledge that the code sample is correct but documentation wrong
1 parent 22da0cc commit 1ef3241

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

docs/the-new-architecture/pillars-turbomodule.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ The upper part of the file contains some descriptive information like the name o
166166
167167
Then there are the dependencies for this package. For this guide, you need `react` and `react-native`.
168168
169-
Finally, the **Codegen** configuration is specified by the `codegenConfig` field. It contains an array of libraries, each of which is defined by three other fields:
169+
Finally, the **Codegen** configuration is specified by the `codegenConfig` field. It contains an object that defines the module through four fields:
170170
171171
- `name`: The name of the library. By convention, you should add the `Spec` suffix.
172172
- `type`: The type of module contained by this package. In this case, it is a Turbo Native Module; thus, the value to use is `modules`.

0 commit comments

Comments
 (0)