react-navigation / react-navigation/react-navigation.github.io

Rephrasing for clarity in `creating-a-stack-navigator`

Open
#614 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
324
Forks
2k
PR merge metrics
No merged PRs in 30d

Description

https://reactnavigation.org/docs/en/hello-react-navigation.html#creating-a-stack-navigator

I believe that the following sentence is rather hard to parse as a reader

createAppContainer is a function that returns a React component to take as a parameter the React component created by the createStackNavigator, and can be directly exported from App.js to be used as our App's root component.

perhaps the following would make more sense?

createAppContainer is a function that takes the React component created by calling createStackNavigator and returns a component that can be directly exported from App.js to be used as our App's root component.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the creating-a-stack-navigator section at the linked React Navigation documentation URL and compare the current sentence with the suggested rephrasing. Update the sentence for clearer grammar while preserving its meaning. Done means the section reads naturally and accurately explains the roles of createAppContainer, createStackNavigator, and App.js.

Written by the indexing model from the issue text.

Assessment

Tech stack
react, react-native
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.