Garantías de versión

La biblioteca sigue el principio de versionado semántico lo que significa que la mayor versión es actualizada cada vez que hay un cambio incompatible en la API. Sin embargo, debido a la falta de garantías en el lado de Discord cuando se refiere a ruptura de cambios junto con la naturaleza bastante dinámica de Python, puede ser difícil discernir que se puede considerar una ruptura de cambios o no.

La primera cosa a tener en cuenta es que la ruptura de cambios solo se aplica a funciones y clases públicamente documentadas. Si no aparece en la documentación, no es parte de la API pública y puede cambiar en cualquier momento. Esto incluye atributos que empiezan por una barra baja o funciones que no estén documentadas.

Nota

Los siguientes ejemplos no son exhaustivos.

Ejemplos de roturas de cambios

  • Cambiar el valor por defecto del parámetro a otra cosa.

  • Renombrar una función sin alias a una función antigua.

  • Añadir o quitar parámetros a un evento.

Ejemplos de cambios sin rupturas

  • Añadir o quitar atributos privados.

  • Añadir un elemento en los __slots__ de una clase de datos.

  • Cambiar el comportamiento de una función para arreglar un bug.

  • Cambios en la documentación.

  • Modificar el manejo del HTTP interno.

  • Actualizar las dependencias a una nueva versión, mayor o de otro tipo.