Include type constraints in documentation
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 45/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Tech-Stack
- fsharp
- Bereich
- documentation
Rechercherichtung
Beginnen Sie mit der verlinkten Referenzdokumentation zu hash und compare und überprüfen Sie den Workflow des Repositorys für die generierte API-Dokumentation. Vergleichen Sie die dokumentierten Typparameter mit der verlinkten Liste der F#-Constraints, aktualisieren Sie anschließend die relevanten Dokumentationseingaben, sodass betroffene APIs ihre Constraints anzeigen, und überprüfen Sie die generierten Seiten.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
The documentation for hash does not say that it requires the equality constraint on its only type parameter. Another example is the documentation for compare. It requires the comparison type constraint on its only type parameter. For convenience, here is the list of all type constraints.
Could type constraints be added to the documentation for types that have them?
- Vorherrschende Sprache
- Keine Sprachdaten
- Sterne
- 37
- Forks
- 20
- Ø Merge
- 5 Min.
- Gemergte PRs (30 T.)
- 2
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
- Forken Sie das Repository und arbeiten Sie in einem Branch.
- Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.
Mehr aus fsharp/fsharp-core-docs
-
Missing namespaces? Offen
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 45/100
fsharp/fsharp-core-docs#104 · 6 Kommentare ·
-
Schwierigkeit 4/5 3-5 Tage Anfängerfreundlichkeit 25/100
fsharp/fsharp-core-docs#103 · 4 Kommentare ·
-
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 38/100
fsharp/fsharp-core-docs#82 ·
-
Move to docs.fsharp.org? Offen
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
fsharp/fsharp-core-docs#76 · 4 Kommentare · 9 Reaktionen ·
-
Schwierigkeit 5/5 Über eine Woche Anfängerfreundlichkeit 25/100
fsharp/fsharp-core-docs#75 · 3 Kommentare · 1 Reaktion ·
Alle Issues in fsharp/fsharp-core-docs
Ähnliche Issues
-
Crush Offen
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 85/100
catppuccin/catppuccin#3125 ·
-
Link Checker Report Offenautomated issue report
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 95/100
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
VoltAgent/awesome-design-md#469 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
KhronosGroup/glTF#2648 ·
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 90/100
sccn/sccn.github.io#108 ·