Clarify role of precision when specifying floats to `subspace`
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 65/100
- Tipo de issue
- Documentação
- Clareza
- Razoavelmente clara
- Status de atividade
- Pouca atividade
- Stack de tecnologia
- python
- Domínio
- documentation
Direção de pesquisa
Comece localizando a docstring de subspace e o tutorial; em seguida, investigue outros métodos que aceitam valores de dados float para correspondência de coordenadas. Documente o risco de precisão e recomende isclose, com um exemplo de aviso baseado na issue; considera-se concluído quando as docstrings relevantes e o tutorial explicarem como evitar incompatibilidades de arredondamento.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
From #799 we have seen that specifying a float data value to reference a coordinate value to a method that attempts to match it to some data in the (meta)data, such as subspace, may fail due to the natural unreliability of floating point precision due to rounding, e.g where matching to 0.123 fails but cf.isclose(0.123) will pass.
This isn't covered at all in the documentation, but can mean that users get unexpected results, like with that issue. So it is important to advertise that it is safest to use methods such as isclose when specifying float values if there is reasonable chance for rounding mismatch.
I recommend we clarify this, in (at least) two locations:
- in the docstrings of methods where float data values can be provided, which is at least
subspacebut perhaps includes other methods (to be investigated); - in the tutorial, as (I am thinking) a
warningbox with an example higlighting an example such as that from the linked Issue.
- Linguagem predominante
- Python
- Estrelas
- 151
- Forks
- 23
- Merge médio
- 1d 2h
- PRs com merge (30d)
- 1
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Sem modelo de pull request
- Ler o guia de contribuição
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 NCAS-CMS/cf-python
-
installation
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 45/100
-
Attempt at unsupported conservative 3D mesh regriddingTalvez livre de novo @sadielbartholomew assumiu há 40 dias e não há nenhum pull request aberto. Abertabug?
-
bug
Dificuldade 3/5 1-2 dias Facilidade para iniciantes 45/100
-
API review (4.0.0) documentation
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
-
Testing of to/from xarrayAbertaenhancement xarray
Dificuldade 4/5 3-5 dias Facilidade para iniciantes 48/100
Todas as issues de NCAS-CMS/cf-python
Issues semelhantes
-
[Bug]: `hermes plugins update` clones an entire monorepo twice - `subdir` is resolved but dropped at both catalog-update call sitesTalvez já em andamento @HootRock assumiu hoje. Abertacomp/cli P2 type/perf
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
NousResearch/hermes-agent#142417 · 2 comentários ·
Mantenedores costumam responder em até 1 dia
-
bug enhancement python
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 85/100
DewaldOosthuizen/tech-cheat-sheets-and-notes#392 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
Mantenedores costumam responder em até 1 dia
-
bug p2
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
amd/gaia#5471 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
Restore postgresql_vm_test_charm actions.yaml change (removed in canonical/postgresql-operator#2054)Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 85/100
canonical/postgresql-single-kernel-library#390 · 1 comentário ·
Mantenedores costumam responder em até 2 dias