Garanties quant au versionnage

La bibliothèque suit le principe de versionnage sémantique, ce qui signifie que la version majeure est mise à jour à chaque changement incompatible de l’API. Cependant, en raison de l’absence de garanties du côté de Discord concernant les changements incompatibles, ainsi que de la nature assez dynamique de Python, il peut être difficile de discerner ce qui peut être considéré comme un changement incompatible et ce qui ne l’est pas.

La première chose à garder à l’esprit est que les changements incompatibles ne s’appliquent qu’aux fonctions et classes documentées publiquement. Si elles ne figurent pas dans la documentation ici, elles ne font pas partie de l’API publique et sont donc susceptibles de changer. Cela inclut les attributs commençant par un tiret bas ou les fonctions avec ou sans tiret bas qui ne sont pas documentées.

Note

Les exemples ci-dessous sont non exhaustifs.

Exemples de changements incompatibles

• Modifier la valeur par défaut d’un paramètre à autre chose.

• Renommer une fonction sans ajouter alias vers une ancienne fonction.

• Ajouter ou supprimer des paramètres à un événement.

Exemples de changements non incompatibles

• Ajouter ou supprimer des attributs privés avec un tiret bas.

• Ajouter un élément dans les __slots__ d’une classe de données.

• Modifier le comportement d’une fonction pour corriger un bogue.

• Changements dans la documentation.

• Modifier la gestion interne des requêtes HTTP.

• Mettre à jour les dépendances vers une nouvelle version, majeure ou autre.