reactjs / reactjs/react.dev

Variable naming inconsistency in the tutorial documentation

未关闭 适合新手
#4,823 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
JavaScript
星标
11.8k
派生
7.9k
平均合并
1 天 11 小时
30 天内合并 PR
11

描述

Hi,
I have just used the React tutorial, it is great!
It helps a lot to learn the basic.

While working, I have spotted a small inconsistency on https://github.com/reactjs/reactjs.org/blob/main/content/tutorial/tutorial.md

When creating the buttons to move into the history, we are using a move variable that we are sending to jumpTo:

image

But jumpTo use step to make the moves:

image

I suggest that we switch the move and step variables of the render function to make the tutorial more understandable by beginners:

image

I can push a merge request for the documentation but I do not know how to change the source code linked by @gaearon on codepen:
https://codepen.io/gaearon/pen/gWWZgR?editors=0010

Is there a way to do that?

贡献指南

打开贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

从 content/tutorial/tutorial.md 开始,结合 jumpTo 阅读教程中的 render 函数,以确认变量命名不一致的问题。检查链接的 CodePen,以确定它是否也属于所请求的文档变更。完成的标准是教程使用一致的名称,并且相关示例对初学者来说仍然易于理解。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript, react
领域
documentation
Issue 类型
文档
难度
1/5
预计耗时
1 小时以内
活跃度
停滞
描述清晰度
描述清楚
新手友好度
72/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。