Typo in Higher Order Components page
Open
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 11.8k
- Forks
- 7.9k
- Avg merge
- 1d 11h
- Merged PRs (30d)
- 11
Description
Hello,
I am new to React so I could be wrong but I think I spotted an issue in this section. Instead of this:
const CommentListWithSubscription = withSubscription(
CommentList,
(DataSource) => DataSource.getComments()
);
const BlogPostWithSubscription = withSubscription(
BlogPost,
(DataSource, props) => DataSource.getBlogPost(props.id)
);
I believe it should say that:
const CommentListWithSubscription = withSubscription(
Comment,
(DataSource) => DataSource.getComments()
);
const BlogPostWithSubscription = withSubscription(
TextBlock,
(DataSource, props) => DataSource.getBlogPost(props.id)
);
i.e. the WrappedComponent argument of the withSubscription HOC is wrong in both declarations.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the linked Higher Order Components page and locate the “use HOCs for cross-cutting concerns” section. Compare both withSubscription examples with the reported component names, then verify the documentation renders correctly; it is done when the examples use the intended wrapped components.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript, react
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100