ipython / ipython/traitlets

Promise not to remove Sentinel?

Ouverte
#865 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub
Langage dominant
Python
Étoiles
653
Forks
217
Merge moyen
2 j 21 h
PR mergées (30 j)
2

Description

In https://github.com/ipython/traitlets/commit/bbbdfbbf57d06487e3acd54d954fe512e5d1b693 Sentinel was made deprecated. In the warning it mentions it might be removed `"It was published by mistake, and may be removed in the future."`.

Sentinel is already used in traittypes, and now people are afraid this will cause a breakage in the future:
* https://github.com/jupyter-widgets/traittypes/issues/47

I think there is a tendency in the Python community to remove deprecated 'things', I think we should not do that.
Instead, we should try not to touch the deprecated parts, especially if they are 'islands of code' like the Sentinel class is, since it would not increase the maintainance burden at all I think.

Removal and renaming have caused a lot of pain and suffering for library maintainers and users and caused a lot of trust issues.

I suggest we either promise to not remove it, or mention we try to not do that.

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Start by reviewing commit bbbdfbbf57d06487e3acd54d954fe512e5d1b693 and the linked traittypes issue to understand Sentinel's deprecation and downstream concerns. Done would require a decided project policy on whether Sentinel remains supported, with that decision communicated in the appropriate project documentation or deprecation guidance.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
python
Domaine
developer-experience
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
À clarifier
Accessibilité débutants
20/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.