solidjs / solidjs/solid-docs

[Content]: misleading section about when derived-signals are called

Offen
#692 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

solid
Vorherrschende Sprache
MDX
Sterne
292
Forks
361
Ø Merge
7 Std. 51 Min.
Gemergte PRs (30 T.)
1

Beschreibung

📚 Subject area/topic

concepts/derived-values/derived-signals

📋 Page(s) affected (or suggested, for new content)

https://docs.solidjs.com/concepts/derived-values/derived-signals

📋 Description of content that is out-of-date or incorrect

These functions are not executed immediately, but instead are only called when the values they rely on are changed. When the underlying signal is changed, the function will be called again to produce a new value.

I'm beginning with solidjs, so maybe I got this wrong, but I think this is at least misleading.

It is not called when count() changed (click "call inc").
It is only called, if it is explicitly called (in the example click "call double") or if it is used in a reactive context (uncomment {/*<div>double: {double()}</div>*/})

🖥️ Reproduction in StackBlitz (if reporting incorrect content or code samples)
import { render } from "solid-js/web";
import { createSignal } from "solid-js";

function App() {
    const [count, setCount] = createSignal(0);

    const inc = () => setCount(count() + 1)
    const double = () => {console.log("double called"); return count() * 2}

    return (
        <div>
            <div>count: {count()}</div>
            {/*<div>double: {double()}</div>*/}
            <button onClick={() => inc()}>call inc</button>
            <button onClick={() => double()}>call double</button>
        </div>
    );
}

render(() => <App />, document.getElementById('app'));

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

Beginne mit der im Issue verlinkten Dokumentationsseite zu derived-signals und vergleiche die dort zitierte Erklärung mit der bereitgestellten SolidJS-Reproduktion. Aktualisiere die Formulierung so, dass sie korrekt beschreibt, wann die Funktion ausgeführt wird, und überprüfe anschließend das Beispiel und das daraus resultierende Verhalten in der Dokumentation.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
javascript
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

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