reactjs / reactjs/react.dev

[Suggestion]: The process of commit phase is not clear.

Aberta
#7,429 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

type: documentation
Linguagem predominante
JavaScript
Estrelas
11.8k
Forks
7.9k
Merge médio
1d 11h
PRs com merge (30d)
11

Descrição

Summary

A more detailed explanation between the process of commit phase and Browser paint. And

Page

https://react.dev/learn/render-and-commit#step-3-react-commits-changes-to-the-dom

Details

At the end of this section, it summrize that Any screen update in a React app happens in three steps:Trigger, Render and Commit, but this section is actually divided into four subsections

  1. Step 1: Trigger a render
  2. Step 2: React renders your components
  3. Step 3: React commits changes to the DOM
  4. Epilogue: Browser paint

I can't figure out if the process of commit phases include Browser paint. In the Synchronizing with Effects section, it mentions that Effect will run after every commit. I think including browser paint into the process of commit phase is expected, and it would make sense to cut down this section into just three subsections, including browser paint into submit subsection.

Also in the Synchronizing with Effects section, there are two sentences like so:

Effects run at the end of a commit after the screen updates.
By default, your Effect will run after every commit.

I am not a English navitive speaker, and I think at the end of and after have different meaning, at the end of show something happens in the process of commit , while after doesn't. It would make sense to change at the end of to another phrase.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece pela página “Render and commit”, especialmente pela Etapa 3 e pelo epílogo “Browser paint”, e depois compare a terminologia dela com “Synchronizing with Effects”. O trabalho estará concluído quando a documentação distinguir claramente commit de browser paint e resolver a redação inconsistente entre “at the end of” e “after”.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
javascript, react
Domínio
documentation
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.