Inaccurate/misleading description of max in operators module (wrt. NaN comparison)
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 38/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- À l'abandon
- Domaine
- documentation
Piste de recherche
Examinez les entrées de documentation générées pour max et compare liées dans l’issue, puis reproduisez les exemples de NaN présentés afin de confirmer le comportement. Déterminez si l’écart est attendu ; le travail est terminé lorsque la documentation explique correctement le comportement de NaN de max ou qu’il est démontré que l’issue est un bug nécessitant une correction séparée.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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?
- Langage dominant
- Aucune donnée de langage
- Étoiles
- 37
- Forks
- 20
- Merge moyen
- 5 min
- PR mergées (30 j)
- 2
Préparer son environnement
Nous n'avons pas encore vérifié les fichiers d'installation de ce projet. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de fsharp/fsharp-core-docs
-
Missing namespaces?Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 45/100
fsharp/fsharp-core-docs#104 · 6 commentaires ·
-
Build doesn't work on Linux?Ouverte
Difficulté 4/5 3-5 jours Accessibilité débutants 25/100
fsharp/fsharp-core-docs#103 · 4 commentaires ·
-
Move to docs.fsharp.org?Ouverte
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
fsharp/fsharp-core-docs#76 · 4 commentaires · 9 réactions ·
-
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
fsharp/fsharp-core-docs#75 · 3 commentaires · 1 réaction ·
-
fsdocs
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
fsharp/fsharp-core-docs#65 · 5 commentaires ·
Toutes les issues de fsharp/fsharp-core-docs
Issues similaires
-
area:docs area:render bug criticality:p3 triage:needs-implementation
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
registrystack/registry-stack#1618 ·
Les mainteneurs répondent en général sous 1 jour
-
curriculum documentation quality
Difficulté 2/5 1-3 heures Accessibilité débutants 78/100
githubnext/gh-aw-workshop#3897 ·
Les mainteneurs répondent en général sous 2 jours
-
Outdated json schema for v1.14Ouverte
Difficulté 2/5 1-3 heures Accessibilité débutants 76/100
siderolabs/docs#791 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 75/100
nestjs/docs.nestjs.com#3554 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 1/5 Moins d'une heure Accessibilité débutants 98/100
huggingface/course#1320 ·
Les mainteneurs répondent en général sous 1 jour