Inaccurate/misleading description of max in operators module (wrt. NaN comparison)
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 38/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Estagnada
- Domínio
- documentation
Direção de pesquisa
Revise as entradas de documentação geradas para max e compare vinculadas na issue e, em seguida, reproduza os exemplos de NaN mostrados para confirmar o comportamento. Determine se a discrepância é esperada; considera-se concluído quando a documentação explica corretamente o comportamento de NaN de max ou quando fica demonstrado que a issue é um bug que requer uma correção separada.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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?
- Linguagem predominante
- Sem dados de linguagem
- Estrelas
- 37
- Forks
- 20
- Merge médio
- 5min
- PRs com merge (30d)
- 2
Preparar o ambiente
Ainda não verificamos os arquivos de configuração deste projeto. Comece pelo README e veja nosso guia da primeira contribuição para os passos gerais.
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de fsharp/fsharp-core-docs
-
Missing namespaces?Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 45/100
fsharp/fsharp-core-docs#104 · 6 comentários ·
-
Build doesn't work on Linux?Aberta
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 25/100
fsharp/fsharp-core-docs#103 · 4 comentários ·
-
Move to docs.fsharp.org?Aberta
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
fsharp/fsharp-core-docs#76 · 4 comentários · 9 reações ·
-
Dificuldade 5/5 Mais de uma semana Facilidade para iniciantes 25/100
fsharp/fsharp-core-docs#75 · 3 comentários · 1 reação ·
-
fsdocs
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 45/100
fsharp/fsharp-core-docs#65 · 5 comentários ·
Todas as issues de fsharp/fsharp-core-docs
Issues semelhantes
-
Broken links found in docsAbertadocs pydanty:is-working
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 75/100
pydantic/pydantic-ai#8863 ·
Mantenedores costumam responder em até 1 dia
-
documentation from-review-extraction github-actions priority: low severity:nit
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
LearningCircuit/local-deep-research#6946 ·
Mantenedores costumam responder em até 1 dia
-
enhancement
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 88/100
esphome/device-builder#2856 ·
Mantenedores costumam responder em até 1 dia
-
documentation good first issue
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 95/100
-
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 78/100
mantinedev/mantine#9223 ·
Mantenedores costumam responder em até 6 dias