Clarify role of precision when specifying floats to `subspace`
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 3/5
- Tempo stimato
- 1-2 giorni
- Idoneità per principianti
- 65/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Inizia individuando la docstring di subspace e il tutorial, quindi esamina gli altri metodi che accettano valori di dati float per la corrispondenza delle coordinate. Documenta il rischio di precisione e consiglia isclose, con un esempio di avviso basato sull’issue; il lavoro è completato quando le docstring pertinenti e il tutorial spiegano come evitare discrepanze di arrotondamento.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
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.
- Lingua principale
- Python
- Stelle
- 151
- Fork
- 23
- Merge medio
- 21h 29m
- PR unite (30g)
- 1
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Nessun modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di NCAS-CMS/cf-python
-
code tidy
Difficoltà 2/5 1-3 ore Idoneità per principianti 76/100
-
Attempt at unsupported conservative 3D mesh regriddingForse già presa @sadielbartholomew l’ha presa 22 giorni fa. Apertabug?
-
Release: migrate from deprecated build commandForse già presa @sadielbartholomew l’ha presa 24 giorni fa. Apertarelease
-
Remove support for Python 3.10 (EOL)Forse già presa @sadielbartholomew l’ha presa 24 giorni fa. Apertaenhancement
-
bug
Difficoltà 3/5 1-2 giorni Idoneità per principianti 45/100
Tutte le issue di NCAS-CMS/cf-python
Issue simili
-
adr
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
kristofdegrave/homeassistant-smart-charging#1607 ·
I maintainer di solito rispondono entro 1 giorno
-
namespace operations
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
EclipseFdn/open-vsx.org#13665 ·
I maintainer di solito rispondono entro 1 giorno
-
doc good first issue help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
collective/icalendar#1865 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
canonical/opentelemetry-collector-operator#409 ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 85/100
mozilla/addons-release-tests#1243 ·
I maintainer di solito rispondono entro 1 giorno