Inaccurate/misleading description of max in operators module (wrt. NaN comparison)
Dieses Issue hat noch niemand übernommen.
Bewertung
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Anfängerfreundlichkeit
- 38/100
- Issue-Typ
- Dokumentation
- Klarheit
- Größtenteils klar
- Aktivitätsstatus
- Veraltet
- Bereich
- documentation
Rechercherichtung
Überprüfe die im Issue verlinkten generierten Dokumentationseinträge für max und compare und reproduziere anschließend die gezeigten NaN-Beispiele, um das Verhalten zu bestätigen. Ermittle, ob die Abweichung erwartungsgemäß ist; abgeschlossen bedeutet, dass die Dokumentation das NaN-Verhalten von max korrekt erklärt oder dass sich das Issue als Fehler erweist, der eine separate Behebung erfordert.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Beschreibung
Not sure if this is an error in documentation or purposeful omission, or perhaps a bug in fsharp.
Here max is described as
Maximum based on generic comparison
And here compare is described as
Generic comparison.
However, even though they kind of boil down to the same thing in implementation for most types, they do not specifically for floating point numbers. Moreover, if one defines a max function with compare, for example like this:
let max2 x y = if compare x y < 0 then y else x
Then max2 behaves differently than max with respect to NaN, e.g.:
> max2 1. nan;;
val it: float = 1.0
> max2 nan 1.;;
val it: float = 1.0
whereas
> max nan 1.;;
val it: float = nan
> max 1. nan;;
val it: float = nan
If this discrepancy in behavior is expected, then perhaps it should be documented?
- 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 ·
-
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 ·
-
fsdocs
Schwierigkeit 3/5 1-2 Tage Anfängerfreundlichkeit 45/100
fsharp/fsharp-core-docs#65 · 5 Kommentare ·
Alle Issues in fsharp/fsharp-core-docs
Ähnliche Issues
-
Schwierigkeit 1/5 Unter einer Stunde Anfängerfreundlichkeit 95/100
Git-it-App/git-it-electron#1047 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
neondatabase/website#5944 ·
-
📕documentation
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 75/100
db-ux-design-system/core-web#8239 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100
libsdl-org/sdlwiki#1008 ·
-
Schwierigkeit 2/5 1-3 Stunden Anfängerfreundlichkeit 70/100