reactjs / reactjs/react.dev

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

Offen
#7,429 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

type: documentation
Vorherrschende Sprache
JavaScript
Sterne
11.8k
Forks
7.9k
Ø Merge
1 T. 11 Std.
Gemergte PRs (30 T.)
11

Beschreibung

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.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie mit der Seite „Render and commit“, insbesondere mit Schritt 3 und dem Nachwort „Browser paint“, und vergleichen Sie anschließend deren Terminologie mit „Synchronizing with Effects“. Erledigt ist die Aufgabe, wenn die Dokumentation klar zwischen Commit und Browser-Paint unterscheidet und die uneinheitliche Formulierung „at the end of“ gegenüber „after“ auflöst.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript, react
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.