Clarify role of precision when specifying floats to `subspace`
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 3/5
- Temps estimé
- 1-2 jours
- Accessibilité débutants
- 65/100
- Type d'issue
- Documentation
- Clarté
- Plutôt claire
- Activité
- Calme
- Stack technique
- python
- Domaine
- documentation
Piste de recherche
Commencez par localiser la docstring de subspace et le tutoriel, puis examinez les autres méthodes qui acceptent des valeurs de données float pour la mise en correspondance des coordonnées. Documentez le risque lié à la précision et recommandez isclose, avec un exemple d’avertissement basé sur l’issue ; le travail est terminé lorsque les docstrings concernées et le tutoriel expliquent comment éviter les écarts d’arrondi.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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.
- Langage dominant
- Python
- Étoiles
- 151
- Forks
- 23
- Merge moyen
- 1 j 2 h
- PR mergées (30 j)
- 1
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Aucun modèle de pull request
- Lire le guide de contribution
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 NCAS-CMS/cf-python
-
installation
Difficulté 4/5 3-5 jours Accessibilité débutants 45/100
-
Attempt at unsupported conservative 3D mesh regriddingPeut-être à nouveau libre @sadielbartholomew l’a pris il y a 38 jours, et aucune pull request n’est ouverte. Ouvertebug?
-
error from netCDF in cf.writeOuvertebug
Difficulté 3/5 1-2 jours Accessibilité débutants 45/100
-
API review (4.0.0) documentation
Difficulté 4/5 3-5 jours Accessibilité débutants 48/100
-
Testing of to/from xarrayOuverteenhancement xarray
Difficulté 4/5 3-5 jours Accessibilité débutants 48/100
Toutes les issues de NCAS-CMS/cf-python
Issues similaires
-
Difficulté 1/5 1-3 heures Accessibilité débutants 68/100
FavioVazquez/showtime#101 ·
Les mainteneurs répondent en général sous 1 jour
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 83/100
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 65/100
rossant/awesome-math#199 ·
-
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
nautechsystems/nautilus_trader#5365 ·
Les mainteneurs répondent en général sous 1 jour
-
Examples say cnxOuvertedocumentation embedded
Difficulté 2/5 1-3 heures Accessibilité débutants 68/100
Les mainteneurs répondent en général sous 1 jour