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

Mistake in the linking docs

Open
#890 0 comments 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

In the section Serializing and parsing params the example tries to achieve the following state

const state = {
  routes: [
    {
      name: 'Chat',
      params: { at: 1589842744264 },
    },
  ];
}

with the param named at.
But the path to it being chat/:date.

Meaning the resulting route param would be

params: {date: 1589842744264}

This needs fixing, and also I'm missing an option in renaming the state params from the path params.
As in this example we want to map chat/:date to at param.

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

Start with the linked “Serializing and parsing params” documentation section and compare the chat/:date path with the shown at state parameter. Done means the example is internally consistent and the documentation clearly addresses whether path parameters can be mapped to differently named state parameters.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, react-native
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.