Skip to content

Commit 5d09a3b

Browse files
nahumzsdanez
authored andcommitted
Improving resolver documentation 2.0
I tried to understand how to use the resolvers and was not clear for me how to do that until googling and landing in this issue #244 which asked to improve the documentation, which ended with this PR #328 which improved as well the documentation, but wasn't that clear to me, because I read that part of the documentation, I think adding the `reactDocs.parse` is crystal clear how to use it.
1 parent 2086faf commit 5d09a3b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ Type: `(ast: ASTNode, parser: { parse: (string) => ASTNode }) => (NodePath | Arr
9191

9292
Given an AST and a reference to the parser, it returns an (array of) NodePath which represents the component definition.
9393

94-
*Built-in resolvers are available under the `resolver` property, e.g. `reactDocgen.resolver.findAllComponentDefinitions`*
94+
*Built-in resolvers are available under the `resolver` property, e.g. `reactDocs.parse(src, reactDocgen.resolver.findAllComponentDefinitions)`*
9595

9696
#### handlers
9797

0 commit comments

Comments
 (0)