google / google/codeworld

Parameter names in auto-generated docs for builtin symbols

Offen
#815 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
enhancement
Vorherrschende Sprache
Haskell
Sterne
1.3k
Forks
201
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

The autogenerated docs for built-in symbols currently just have a line number. In certain cases (at least when it's easy) it would be great to include the parameter names from a function declaration. There are hard cases, such as when a function has multiple parameters and doesn't use the same name each time -- or even pattern matches so there is no name for the overall parameter. It's okay to skip these (except for tuples, of course).

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Es wird keine Datei oder kein Test genannt. Beginne damit, den Code zu finden, der die Dokumentation für integrierte Symbole erzeugt, und verfolge, wie Funktionsdeklarationen dargestellt werden; das gewünschte Ergebnis ist, Parameternamen anzuzeigen, wenn sie eindeutig sind, nicht unterstützte Fälle zu überspringen und weiterhin Tupel zu verarbeiten.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
haskell
Bereich
documentation
Issue-Typ
Feature
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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